Pular para o conteúdo principal
POST
Criar webhook

Autorizações

Authorization
string
header
obrigatório

API key sk_live_... ou sk_test_....

Corpo

application/json
name
string
obrigatório

Nome interno no painel.

url
string<uri>
obrigatório

URL HTTPS que recebe POST JSON.

events
string[]
obrigatório

Nomes de evento (ex.: message.sent).

instanceIds
string[]

Filtra por instâncias; vazio = todas.

enabled
boolean
padrão:true
domainIds
string[]

Filtra por domínios de e-mail; vazio = todos.

pushAppIds
string[]

Filtra por apps push; vazio = todos.

headers
object

Encabezados HTTP personalizados opcionales: hasta 10 pares; los nombres deben seguir el formato token HTTP y tener como máximo 128 caracteres; los valores pueden tener hasta 2.048 caracteres y no incluir saltos de línea. Host, Content-Length, Content-Type, Transfer-Encoding, Connection y X-Notifique-* están reservados. Los valores se cifran y se enmascaran en las respuestas GET.

Exemplo:

Resposta

Webhook criado com secret (exibido uma vez).

success
boolean
data
object