DOCS

Webhook HTTP (Saída) do Chatbot

Estrutura enviada pelo node NodeHttpWebhook para a URL configurada no fluxo. Este endpoint deve ser implementado pelo cliente/terceiro para receber os dados e reagir conforme necessário.

Evento

POST messenger/chatbot/NodeHttpWebhook

Como receber

Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.

Payload

  • Content-Type: application/json
CampoTipoObrigatórioValores / ExemploDescrição
roomIdstringSimID da sala (room) no banco
chIdstringSimIdentificador do canal. No WhatsApp (chSrc=1) é o número do cliente.
chSrcintegerSimCanal de origem (1=WhatsApp, 2=Facebook, 3=Instagram, 4=SMS)
messagestring,nullNãoTexto da mensagem atual (quando houver)
interactiveReplystring,nullNãoResposta interativa do usuário (payload/id) quando aplicável
currNodeIdstringSimID do node atual no fluxo
varsobjectSimVariáveis persistidas no contexto do fluxo (roomData.vars)
mediaNodeHttpWebhookMedia | nullNãoMídia/arquivo quando a mensagem contém anexo
_waReferralNodeHttpWebhookReferral | nullNãoReferral do WhatsApp quando o webhook de mensagem veio com message.referral

Estruturas internas

media

{
  "url": "string (uri)",
  "mimeType": "string"
}

_waReferral

{
  "body": "string",
  "ctwa_clid": "string",
  "headline": "string",
  "image": {
    "id": "string"
  },
  "source_id": "string",
  "source_type": "string",
  "source_url": "string"
}

Exemplo básico recebido:

{
  "roomId": "valor",
  "chId": "valor",
  "chSrc": 1,
  "currNodeId": "valor",
  "vars": {}
}

Respostas

StatusDescriçãoConteúdo
200Qualquer resposta 2xx é considerada sucesso
500Erro no processamento do receiver

Boas práticas

  • Trate reenvios como possibilidade real.
  • Valide o payload antes de executar regras de negócio.
  • Registre o identificador do evento ou do registro recebido para auditoria.