Passar para o conteúdo principal

Como configurar e usar webhooks no Wati

Atualizado hoje

Resumo

Webhooks no Wati permitem que você receba atualizações em tempo real sobre mensagens e seus status enviando dados de eventos para seu servidor. Este guia explica quais eventos você pode rastrear, como configurar um webhook e como os retornos de chamada baseados em sessão funcionam para que você possa processar de forma confiável a atividade de mensagens em seu sistema.

Instruções

Quais eventos os webhooks podem capturar?

Os webhooks do Wati podem notificar seu sistema quando os seguintes eventos ocorrem:

  • Mensagens recebidas

  • Mensagens enviadas (mensagens de modelo e sessão)

  • Atualizações de status da mensagem:

    • Enviada

    • Entregue

    • Lida

Esses eventos são enviados para o seu URL de webhook configurado como payloads de callback.

Como adicionar um webhook no Wati

Siga estas etapas para configurar um webhook:

  • Faça login no painel do Wati.

  • Vá para Conectores e clique em Webhooks no menu de navegação superior.

  • Clique em Adicionar Webhook.

  • Insira o URL completo do seu webhook.

  • Defina o status como Ativado.

  • Selecione os eventos que deseja capturar.

  • Clique em Salvar.

Como testar seu webhook

Depois de adicionar o webhook, você pode testar a conexão:

  • Use a opção Acionar callback de amostra.

  • Wati enviará um payload de amostra para seu URL de webhook.

  • Verifique se seu servidor recebe e processa o payload corretamente.

Entendendo webhooks baseados em sessão

Na API WhatsApp Business, as conversas são rastreadas como sessões de 24 horas. Uma sessão começa quando uma mensagem comercial é entregue.

Tipos de sessões

  • Sessão ativa

    • Tanto a empresa quanto o cliente trocaram pelo menos uma mensagem.

    • Exemplo: uma empresa envia uma mensagem de modelo e o cliente responde.

  • Sessão inativa

    • Apenas uma das partes enviou uma mensagem e a outra não respondeu.

    • Exemplo: uma empresa envia uma mensagem de modelo, mas o cliente não responde.

Observação: Os callbacks de webhook podem variar dependendo se a sessão está ativa ou inativa.

Resposta do Webhook e lógica de repetição

Para garantir a entrega confiável, seu webhook deve responder corretamente.

  • Seu servidor deve retornar uma resposta 200 OK para confirmar que o evento foi recebido.

  • Se uma resposta 200 não for recebida:

    • Wati tenta reenviar o evento.

    • As tentativas podem ocorrer até 144 vezes.

    • As tentativas de repetição são executadas em intervalos de 10 minutos.

  • Se houver mais de 100 falhas consecutivas:

    • O webhook é marcado como Defeituoso.

    • Você receberá uma notificação por e-mail.

Se todas as tentativas de repetição falharem, o evento não será mais enviado.

Melhores práticas

  • Certifique-se de que seu endpoint de webhook esteja sempre disponível e responsivo.

  • Registre os payloads recebidos para facilitar a depuração.

  • Lide com eventos duplicados, pois as repetições podem enviar o mesmo payload mais de uma vez.

  • Valide as solicitações recebidas para garantir que elas se originem do Wati.

Esta configuração ajuda você a manter seus sistemas sincronizados com a atividade de mensagens em tempo real no Wati.

Perguntas frequentes (FAQs)

Visão geral dos Webhooks

1. O que os webhooks no Wati fazem?

Os webhooks no Wati enviam atualizações em tempo real sobre mensagens e seus status para seu servidor, entregando dados de eventos a um URL de webhook configurado.

2. Que tipos de eventos os webhooks do Wati podem capturar?

Os webhooks Wati podem capturar os seguintes eventos:

  • Mensagens recebidas

  • Mensagens enviadas (mensagens de modelo e sessão)

  • Atualizações de status da mensagem, incluindo Enviada, Entregue e Lida

Configuração e teste do Webhook

3. Como adicionar e testar um webhook no Wati?

Para adicionar e testar um webhook no Wati:

  • Faça login no painel do Wati.

  • Vá para Conectores e clique em Webhooks.

  • Clique em Adicionar Webhook.

  • Insira o URL do seu webhook e defina o status como Ativado.

  • Selecione os eventos que deseja capturar e clique em Salvar.

  • Use a opção Acionar callback de amostra para enviar um payload de amostra.

  • Verifique se seu servidor recebe e processa o payload corretamente.

Webhooks baseados em sessão

4. O que é uma sessão na API WhatsApp Business?

Uma sessão é uma janela de conversa de 24 horas que começa quando uma mensagem comercial é entregue.

5. Qual é a diferença entre uma sessão ativa e uma sessão inativa?

Uma sessão ativa ocorre quando tanto a empresa quanto o cliente trocaram pelo menos uma mensagem. Uma sessão inativa ocorre quando apenas uma das partes enviou uma mensagem e a outra não respondeu.

Confiabilidade e repetições do Webhook

6. Que resposta seu servidor deve retornar para a entrega bem-sucedida do webhook?

Seu servidor deve retornar uma resposta 200 OK para confirmar que o evento de webhook foi recebido.

7. O que acontece se seu servidor não retornar uma resposta 200 OK?

Se seu servidor não retornar uma resposta 200 OK, Wati tenta reenviar o evento até 144 vezes em intervalos de 10 minutos.

8. O que acontece se a entrega do webhook continuar falhando?

Se houver mais de 100 falhas consecutivas, o webhook será marcado como Defeituoso e uma notificação por e-mail será enviada. Se todas as tentativas de repetição falharem, o evento não será mais enviado.

Melhores práticas

9. Como você pode garantir o processamento confiável do webhook?

Para garantir o processamento confiável do webhook:

  • Mantenha seu endpoint de webhook disponível e responsivo

  • Registre os payloads recebidos para depuração

  • Lide com eventos duplicados porque as repetições podem enviar o mesmo payload mais de uma vez

  • Valide as solicitações recebidas para confirmar que elas se originam do Wati

Respondeu à sua pergunta?