Pular para o conteúdo principal
POST
Criar webhook

Resposta

Eventos disponíveis

Valores aceitos em events. Se o campo não for enviado, o webhook recebe messages.

Autorizações

Authorization
string
header
obrigatório

Token de conta gerado no painel da Datafy, na aba Parceiros. Formato: sk_acct_xxx. Diferente do token de canal (sk_live_).

Parâmetros de caminho

id
string
obrigatório

ID do canal, retornado em Listar canais e em Criar canal.

Corpo

application/json
url
string
obrigatório

URL que recebe os eventos. Precisa usar HTTPS.

Exemplo:

"https://exemplo.com/webhook"

events
enum<string>[]

Eventos que o webhook recebe. Se omitido, recebe messages. Não pode ser uma lista vazia.

Opções disponíveis:
messages,
messaging_postbacks,
messaging_referral,
messaging_seen,
message_reactions,
message_edit,
messaging_optins,
messaging_handover,
standby,
comments,
live_comments
Exemplo:
enabled
boolean
padrão:true

Ativa ou desativa o webhook.

Exemplo:

true

Resposta

Webhook criado.

id
string

ID do webhook.

url
string

URL que recebe os eventos.

events
string[]

Eventos que o webhook recebe.

enabled
boolean

Indica se o webhook está ativo.