Skip to main content
GET
/
webhooks
[
  {
    "id": 1,
    "webhook_id": "wh_1234567890abcdef",
    "name": "Webhook de Entrega",
    "url": "https://meusite.com/webhook",
    "events": [
      "delivered",
      "bounced"
    ],
    "secret_key": "sk_***",
    "is_active": true,
    "retry_count": 3,
    "timeout_seconds": 30,
    "headers": {
      "X-Custom": "valor"
    },
    "created_at": "2025-01-21T16:30:00Z",
    "updated_at": "2025-01-21T16:30:00Z",
    "created_by": "[email protected]"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
is_active
boolean | null

Filtrar por status ativo

​
event_type
enum<string> | null

Filtrar por tipo de evento

Available options:
sent,
delivered,
bounced,
soft_bounced,
hard_bounced,
opened,
clicked,
complaint,
unsubscribed,
deferred,
rejected,
suppressed,
test
​
search
string | null

Buscar por nome ou URL

​
limit
integer
default:100

Limite de resultados

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Offset para paginação

Required range: x >= 0

Response

Lista de webhooks retornada com sucesso

​
id
integer
required
​
webhook_id
string
required
​
name
string
required
​
url
string
required
​
events
enum<string>[]
required

Tipos de eventos de email que podem disparar webhooks

Available options:
sent,
delivered,
bounced,
soft_bounced,
hard_bounced,
opened,
clicked,
complaint,
unsubscribed,
deferred,
rejected,
suppressed,
test
​
is_active
boolean
required
​
retry_count
integer
required
​
timeout_seconds
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
secret_key
string | null
​
headers
Headers · object
​
created_by
string | null