Webhooks

Receba notificacoes em tempo real sobre mensagens e sessoes

Configuracao

Configure a URL e os eventos que deseja receber:

bash

curl -X PUT https://api.zapway.cloud/devices/dev_01/hooks \
  -H "X-Device-Key: sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://seu-servidor.com/webhook",
    "events": [
      "message.received",
      "message.status",
      "session.state"
    ]
  }'

Eventos

message.received

Disparado quando uma nova mensagem e recebida

json

{
  "event": "message.received",
  "deviceId": "dev_01",
  "data": {
    "from": "5511999999999",
    "type": "text",
    "body": "Ola!",
    "timestamp": 1711900000
  }
}

message.status

Disparado quando o status de uma mensagem muda

json

{
  "event": "message.status",
  "deviceId": "dev_01",
  "data": {
    "waMessageId": "3EB0...",
    "status": "delivered",
    "recipient": "5511999999999"
  }
}

session.state

Disparado quando o estado da sessao muda

json

{
  "event": "session.state",
  "deviceId": "dev_01",
  "data": {
    "state": "online",
    "phone": "5511888888888"
  }
}

Testando

Envie um evento de teste para a URL configurada:

bash

curl -X POST https://api.zapway.cloud/devices/dev_01/hooks/test \
  -H "X-Device-Key: sk_live_abc123"