Eventos dos Webhooks

Na API você pergunta; no webhook a Notifique avisa. Ideal para marcar campanha como entregue ou medir clique em botão, sem polling.

Em poucas palavras

Toda entrega é um POST application/json para a URL cadastrada.
Eventos rcs.* são só RCS, SMS usa sms.*, WhatsApp usa message.*.
instanceId vem vazio (RCS não usa instância de canal).
Ative só os eventos que sua integração usa.
Responda 2xx rápido; processamento pesado vai para fila no seu lado.

Configuração geral: Webhooks. Segurança (assinatura HMAC): Segurança de webhooks.

Como vem o POST

{
  "event": "rcs.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}

Campo	Descrição
`event`	Nome do evento (ex.: `rcs.delivered`)
`workspaceId`	ID do workspace
`instanceId`	Sempre vazio no RCS
`timestamp`	ISO 8601, use para anti-replay
`data`	Campos do envio (`rcsId`, `to`, `status`, etc.)

Headers: X-Notifique-Signature, X-Notifique-Timestamp, X-Workspace-Id, X-Webhook-Event.

O que seu servidor deve responder

Resposta	Efeito
2xx em até ~10s	Evento entregue; sai da fila
4xx / 5xx / timeout	Retentativa automática (5 min, 30 min, 2 h)

Processamento demorado? Responda 200 logo e processe em background.

Referência por evento

Evento	Quando dispara	O que fazer com isso
`rcs.sent`	RCS aceito e enviado à rede	Marcar como enviado
`rcs.delivered`	Entregue no dispositivo	Confirmar entrega
`rcs.clicked`	Clique em link curto ou botão	Campanha / conversão
`rcs.failed`	Falha (número sem RCS, etc.)	Fallback SMS ou alerta
`rcs.cancelled`	Agendamento cancelado	Atualizar fila

Payload de cada evento

rcs.sent

{
  "event": "rcs.sent",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:29:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "SENT",
    "sentAt": "2025-02-10T14:29:00.000Z",
    "messageType": "BASIC"
  }
}

rcs.delivered

{
  "event": "rcs.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}

rcs.clicked

Disparado no primeiro clique em link curto rastreado ou botão deste envio.

{
  "event": "rcs.clicked",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:35:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "CLICKED",
    "clickedAt": "2025-02-10T14:35:00.000Z"
  }
}

rcs.failed

Boa prática: acionar fallback (SMS, e-mail) quando o número não suporta RCS.

{
  "event": "rcs.failed",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:29:30.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "FAILED",
    "failedAt": "2025-02-10T14:29:30.000Z",
    "errorMessage": "rcs_not_supported"
  }
}

rcs.cancelled

{
  "event": "rcs.cancelled",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T12:00:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "CANCELLED"
  }
}

Próximos passos

Quick Start: primeiro envio
Introdução: ciclo de status
Escopos: permissões da chave
Webhooks (guia geral)

​Em poucas palavras

​Como vem o POST

​O que seu servidor deve responder

​Referência por evento

​Payload de cada evento

​Próximos passos

Em poucas palavras

Como vem o POST

O que seu servidor deve responder

Referência por evento

Payload de cada evento

Próximos passos