Criando Webhooks
Este endpoint permite registrar um novo webhook para uma instância específica. Os webhooks são usados para receber notificações em tempo real sobre eventos importantes na instância, como mensagens recebidas ou mudanças de status.
⚠️ Importante: É obrigatório fornecer ou uma url
ou um webhook_id
. Se nenhum dos dois for informado, a requisição falhará.
🔍 Considerações
- Pelo menos um evento deve ser especificado na criação do webhook.
- Se uma
url
e umwebhook_id
forem fornecidos ao mesmo tempo, owebhook_id
será priorizado. - O webhook pode ser desativado posteriormente usando a propriedade
enabled
.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Identificador único da instância.
Body
Lista de eventos que acionam o webhook. Deve conter pelo menos um evento.
group.created
, group.participants_added
, group.participants_demoted
, group.participants_promoted
, group.participants_removed
, group.updated
, instance.connected
, instance.disconnected
, instance.forbidden
, instance.mentioned
, instance.qrcode
, message.deleted
, message.delivered
, message.pinned
, message.reaction
, message.read
, message.received
, message.sent
, message.unpinned
, poll.created
, poll.deleted
, poll.updated
["message.received"]
Define se o webhook está ativado. Padrão: true.
true
Nome do webhook configurado.
"Meu Webhook"
Indica se o webhook está em modo de teste. Padrão: false.
false
URL de teste para validar o webhook, se aplicável.
null
URL para onde os eventos do webhook serão enviados. Obrigatório caso webhook_id
não seja fornecido.
"https://webhook.example.com/receive"
ID de um webhook existente para ser reutilizado. Obrigatório caso url
não seja fornecida.
"2nenz69l0xbf0m3uu9tfo"
Response
Resposta ao registrar um webhook.
Data e hora de criação do webhook.
"2025-03-12T23:12:19.448Z"
Indica se o webhook está ativado.
true
Eventos configurados no webhook.
["message.received"]
Identificador único do webhook.
"3nsnz68l0xbf0m3uu9tfo"
Nome do webhook configurado.
"Meu Webhook"
Indica se o webhook está em modo de teste.
false
URL de teste configurada no webhook, se aplicável.
null
URL para onde os eventos do webhook serão enviados.
"https://webhook.mydomain.com"