Configuração de Webhooks

Assine Webhooks para receber notificações sobre sinais de qualidade e alterações nas configurações da sua conta do WhatsApp Business.

A configuração dos Webhooks não afeta o número de telefone do seu app WhatsApp Business. Somente após a migração do telefone para a Plataforma do WhatsApp Business não será mais possível usar esse número no app WhatsApp Business.

Criar um ponto de extremidade

Antes de começar, será necessário criar um ponto de extremidade no seu servidor para receber notificações.

Seu ponto de extremidade deve processar dois tipos de solicitação HTTPS: solicitações de verificação e notificações de evento. Como as duas solicitações usam o HTTPS, seu servidor deve ter um certificado de TLS ou SSL válido configurado e instalado corretamente. Os certificados autoassinados não são compatíveis.

Saiba mais sobre as solicitações de verificação e as notificações de eventos .

Assinar Webhooks

Para assinar Webhooks, será necessário obter um ID e permissões da Meta. Para isso, acesse o Painel de Apps da Meta. Depois, siga estas etapas:

Crie um app no Painel de Apps da Meta .
Adicione o produto Webhooks ao seu app da Meta no Painel de Apps .
Um aplicativo da Meta não pode ter mais de um ponto de extremidade configurado ao mesmo tempo. Use diversos aplicativos da Meta para enviar as atualizações de webhook a múltiplos pontos de extremidade.

Quando estiver tudo pronto para escalar as mensagens da sua empresa, você precisará fazer o seguinte:

Adicione a permissão whatsapp_business_management no Painel de Apps.
Conclua a análise do app da Meta . Essa etapa pode demorar, mas é possível continuar fazendo testes durante todo o processo de análise.

Campos de assinatura disponíveis

Nome do campo	Descrição
`account_review_update`	Uma notificação é enviada quando a análise de uma conta do WhatsApp Business é concluída.
`account_update`	Uma notificação é enviada quando uma alteração é implementada na sua conta do WhatsApp Business. Essa alteração pode incluir uma atualização do número de telefone, uma violação das políticas, o banimento de uma conta do WhatsApp Business, entre outros.
`business_capability_update`	Uma notificação é enviada quando um recurso é atualizado. Isso pode incluir uma alteração no número máximo de telefones que uma WABA pode ter ou o número de conversas por telefone.
`message_template_status_update`	Uma notificação é enviada quando o modelo de mensagem é aprovado, rejeitado ou desativado.
`messages`	Uma notificação é enviada quando a sua empresa recebe uma mensagem de um cliente, quando você envia uma mensagem a um cliente, quando a mensagem é entregue ao cliente e quando a mensagem é lida.
`phone_number_name_update`	Uma notificação é enviada quando o nome associado a um número de telefone é aprovado ou rejeitado.
`phone_number_quality_update`	Uma notificação é enviada quando há uma atualização do status de qualidade de um número de telefone.
`security`	Você receberá uma notificação nos seguintes casos: Ao solicitar a desativação do código de confirmação em duas etapas Quando o código de confirmação em duas etapas é desativado Quando o código de confirmação em duas etapas é atualizado

Acesse a referência de Webhooks sobre contas do WhatsApp Business para mais informações sobre cada campo de carga e a referência de Webhooks sobre a API de Nuvem do WhatsApp para mais informações sobre os diferentes tipos de notificações messages que você pode receber.

Carga de notificação

Todas as notificações têm este formato genérico:

[{
    "object": "whatsapp_business_account",
    "entry": [{
       "id": "{whatsapp-business-account-id}",
        "time": {unix-timestamp},
        "changes": [{
            "field": "{subscribed-field}",
            "value": {
                # Information that was update
            }
          }]
      }]
  }]

A matriz de nível superior contém dois objetos principais:

Parâmetro	Descrição
`object`	Esse é o objeto que foi assinado.
`entry`	Esse objeto contém os detalhes da alteração que disparou a chamada de webhooks.

Consulte Componentes para ver todos os objetos de webhooks disponíveis.

Exemplos de pontos de extremidade do app

Plataforma do WhatsApp Business | API de Nuvem | API Local | API de Gerenciamento do WhatsApp Business