POST
/
wa
/
instances
/
{instance_id}
/
webhooks
curl --request POST \
  --url https://api.zapsterapi.com/v1/wa/instances/{instance_id}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "events": [
    "message.received"
  ],
  "name": "Meu Webhook",
  "test_mode": false,
  "test_url": null,
  "url": "https://webhook.example.com/receive",
  "webhook_id": "2nenz69l0xbf0m3uu9tfo"
}'
{
  "created_at": "2025-03-12T23:12:19.448Z",
  "enabled": true,
  "events": [
    "message.received"
  ],
  "id": "3nsnz68l0xbf0m3uu9tfo",
  "name": "Meu Webhook",
  "test_mode": false,
  "test_url": null,
  "url": "https://webhook.mydomain.com"
}

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 um webhook_id forem fornecidos ao mesmo tempo, o webhook_id será priorizado.
  • O webhook pode ser desativado posteriormente usando a propriedade enabled.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
instance_id
string
required

Identificador único da instância.

Body

application/json

Response

201 - application/json

Webhook registrado com sucesso.

Resposta ao registrar um webhook.