Skip to main content
POST
/
webhooks
{
  "id": 1,
  "webhook_id": "wh_1234567890abcdef",
  "name": "Meu 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.

Body

application/json

Modelo para criação de webhook

​
name
string
required

Nome descritivo do webhook

Required string length: 1 - 255
​
url
string<uri>
required

URL de destino do webhook

Required string length: 1 - 2083
​
events
enum<string>[]
required

Lista de eventos que disparam este webhook

Minimum array length: 1

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
​
secret_key
string | null

Chave secreta para assinatura HMAC

Maximum string length: 255
​
is_active
boolean
default:true

Se o webhook está ativo

​
retry_count
integer
default:3

Número de tentativas em caso de falha

Required range: 0 <= x <= 10
​
timeout_seconds
integer
default:30

Timeout em segundos para requisições

Required range: 5 <= x <= 300
​
headers
Headers · object

Headers customizados para enviar com o webhook

Response

Webhook criado com sucesso

Modelo de resposta para webhook

​
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