Webhooks para a API Local

Assine o Webhooks para obter notificações sobre mensagens recebidas pela sua empresa e atualizações nos perfis de clientes. Consulte a Visão geral, Webhooks para saber mais sobre os Webhooks da Plataforma do WhatsApp Business.

Antes de começar

Você precisará do seguinte:

• Código que dá suporte a HTTPS e tem um certificado SSL válido
• Um ponto de extremidade de URL de retorno de chamada que está configurado para aceitar solicitações de entrada do Coreapp
• Um ponto de extremidade de URL de retorno de chamada que retorna uma resposta HTTPS 200 OK quando uma notificação é recebida

Tentar novamente

Se uma notificação não for entregue por qualquer motivo ou se a solicitação de Webhook retornar um código de status HTTP diferente de 200, tentaremos a entrega novamente. Continuaremos tentando fazer a entrega com atrasos cada vez maiores até atingir um tempo-limite específico (normalmente 24 horas, mas isso pode variar) ou até que a entrega seja bem-sucedida.

Defina o ponto de extremidade de URL do retorno de chamada

Envie uma solicitação PATCH para o ponto de extremidade /v1/settings/application com o parâmetro webhooks definido para o seu ponto de extremidade de URL de retorno de chamada. Outros parâmetros normalmente configurados são sent_status e callback_persist.

Exemplo de solicitação

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

Se bem-sucedida, a resposta retornará 200 OK com null ou um objeto JSON.

Acesse a referência sobre configurações do aplicativo para obter mais informações sobre como configurar seu aplicativo e obter parâmetros adicionais de Webhooks.

Carga de notificação do Webhook

Consulte Components para ver informações sobre cada campo.

Notificação de erro

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

Pontos de extremidade de exemplo de aplicativo

Para testar os seus Webhoooks, é possível criar um exemplo de app com um ponto de extremidade para receber notificações.

• Pontos de extremidade de exemplo de app usando o Glitch