Webhook da Conexão

Nosso Webhook de Conexão envia uma notificação com dados toda vez que essa CONEXÃO:

✅ receber uma mensagem

✅ enviar uma mensagem

✅ alterar uma tag no ticket

✅ alterar o status do ticket (abrir ou fechar)

Sempre que um desses eventos ocorre, nosso webhook envia um payload (dados) para o seu endpoint (URL), notificando automaticamente o sistema receptor.

Como configurar o Endpoint (URL) do sistema receptor

1. Configure seu receptor para receber nossas notificações no método POST.
2. Copie a URL de destino (do seu sistema receptor).
3. Acesse em nosso sistema, o menu Conexões Editar Conexão e no campo Webhook adicione a URL copiada.

📌 Pronto.

Visualize agora as notificações de nossos webhooks chegando em seu enpoint.

Payload Enviado

Um payload diferente é enviado conforme cada tipo de ação. Veja abaixo:

1. Mensagens

{"body": {"filaescolhida": "Dep. Entregas","filaescolhidaid": 5,"mensagem": "Mensagem de teste","sender": "5511999999999","chamadoId": 15321,"acao": "start","name": "José Cliente","companyId": 8,"fromMe": false,"queueId": 5,"isGroup": false,"ticketData": {"id": 15321,"status": "open","protocolo": "54212","contact": {"id": 16991,"name": "José Cliente","number": "5511999999999"},"user": {"id": 71,"name": "João Atendimento","number": "5511987654321"},"queue":{"id": 5,"name": "Dep. Entregas","color": "#f44e3b"},"whatsapp": {"name": "Atendimento","id": 27,"token": "7ydsa6dahdaksdas9","status": "CONNECTED"},"company": {"name": "Atendimento - Minha Empresa"}},"backendURL": "https://backend_url.com.br","token_origin": "7ydsa6dahdaksdas9","msg": {"key": {"remoteJid": "[email protected]","fromMe": false,"id": "3EB46F40017BA9"},"message": {"extendedTextMessage": {"text": "Mensagem de teste"}},"messageTimestamp": "1742906049","status": "PENDING"}},"webhookUrl": "https://go.dominio.com.br/webhook","executionMode": "production"}

Temos alguns tipos de mensagens em “body > msg > message”

São eles:

• conversation (via celular)
• extendedTextMessage (via Web)
• audioMessage
• imageMessage
• videoMessage
• documentMessage
• reactionMessage
• stickerMessage
• contactMessage
• locationMessage

2. Tags

{"body": {"action": "tag-sync","tags": {"ticketId": 15321,"tags": [{"id": 71,"name": "particular","color": "#E1A903","tagType": "Atendimento","companyId": 8}]},"contact": {"id": 16991,"name": "José Cliente","number": "5511999999999"},"connection_token": "7ydsa6dahdaksdas9","apiUrl": "https://backend_url.com.br"},"webhookUrl": "https://go.dominio.com.br/webhook","executionMode": "production"}

3. Abrir ou Fechar Ticket

{"body": {"sender": "5511999999999","chamadoId": 20956,"acao": "open", // closed = se for encerramento de ticket"companyId": 1,"queueId": 16,"isGroup": false,"backendURL": "https://backend_url.com.br","ticketData": {"id": 20956,"status": "pending","protocolo": "29924","contact": {"id": 16991,"name": "José Cliente","number": "5511999999999"},"user": null, // preenchido se estiver em atendimento"queue": {"id": 16,"name": "Dep. Orçamentos","color": "#999999"},"whatsapp": {"name": "Atendimento","id": 27,"status": "CONNECTED"},"company": {"name": "Atendimento - Minha Empresa"}}},"webhookUrl": "https://go.dominio.com.br/webhook","executionMode": "production"}

4. Receber Áudio, Imagem ou Arquivo

O recebimento de áudio, imagem ou arquivo no WhatsApp possui uma particularidade: ele gera dois webhooks seguidos.

O primeiro webhook é parecido com o de “mensagem” porém na propriedade “mensagem” em vez de conter o texto, contém a seguinte informação:

• “mensagem”: “Áudio” (se áudio)
• “mensagem”: ” ” (se imagem ou vídeo)
• “mensagem”: “nome do arquivo” (se PDF)

Na sequência o segundo webhook é recebido, contendo os campos mediaFolder e mediaName para você montar a URL do arquivo (veja o artigo Arquivos no Webhook).