Skip to main content
Um webhook avisa a sua aplicação, em tempo real, quando algo acontece na conta: uma conversa nova, uma mensagem recebida, um contato atualizado. O ChatClean envia um POST com um corpo JSON para a URL que você cadastrar.

Criar um webhook

1

Abra as integrações

Em Configurações → Integrações, abra Webhook.
2

Cadastre a URL

Informe o Nome do Webhook, a URL do Webhook e marque os Eventos que quer receber. Clique em Criar webhook.
3

Guarde o segredo

Ao criar, o ChatClean mostra o Segredo do webhook. Copie e guarde: ele serve para verificar a assinatura das chamadas. Você também encontra o segredo depois, no formulário de edição do webhook.
Também dá para criar webhooks pela API, nas rotas de Webhooks desta referência.

Eventos

O corpo traz o nome do evento em event e os dados do objeto (conversa, mensagem ou contato) junto.

Verificar a assinatura

Quando o webhook tem segredo, cada chamada traz três cabeçalhos: Os nomes dos cabeçalhos são esses mesmos. Para conferir, calcule o HMAC com o corpo exatamente como chegou:
verificar-webhook.js
Recuse a chamada se a assinatura não bater ou se o timestamp for antigo demais (por exemplo, mais de 5 minutos).

Boas práticas

  • Responda rápido, com 200, e processe o evento depois, numa fila.
  • Use o X-Chatwoot-Delivery para ignorar entregas repetidas.
  • A URL precisa ser pública e usar HTTPS.