Para receber notificações sobre sinais de qualidade e alterações nas configurações da sua conta do WhatsApp Business, é possível configurar um ou mais webhooks.
Visto que periodicamente será necessário atualizarmos os webhooks para as novas versões cadastradas na meta, é possível configurar o webhook apontando-o para uma versão exclusiva ou a última versão disponível.
Para isso, utilize o campo meta_version informando os parametros v11, v16 ou LATEST. um webhook de uma versão específica, só será utilizado naquela versão, mas um webhook indicado como LATEST, estará
apto a receber independente da versão configurada. Por padrão, todos os webhooks cadastrados anteriormente e/ou sem o campo meta_version, são contiderados como LATEST.
Para cadastrar um webhook cadastrado, basta enviar uma requisição `POST` para o endpoint `api/Webhooks/`:
Exemplo de cadastro de webhook:
curl --request POST \
--url https://api-cerberus-kong.socialminer.tech/api/Webhooks/ \
--header 'Content-Type: application/json' \
--header 'apikey: {APIKEY}' \
--header 'version: 4.0' \
--data '{
"phone": "5511964557557",
"meta_version":"v16",
"types": ["messages"],
"headers": {
"additionalProp1": "5511964557557",
"additionalProp2": "teste123",
"additionalProp3": "string"
},
"endpoint": "https://webhook.site/1d2befb1-c201-41e9-be6d-53677ca53bc7"
}'
Caso o cadastro ocorraccom sucesso, será retornado o seguinte json com o http status 201:
{
"success": true,
"id": "f2056e5f-46b5-4d91-9a9a-54bb37a436c6",
"phone": "123606713995007",
"phone_id": "123606713995007",
"meta_version":"LASTEST",
"types": ["messages"],
"endpoint": "https://webhook.site/1d2befb1-c201-41e9-be6d-53677ca53bc7",
"create_date": "2023-03-28T13:24:30.9612293+00:00",
"update_date": "2023-03-28T13:24:30.9612306+00:00",
"headers": {
"additionalProp1": "5511964557557",
"additionalProp2": "teste123",
"additionalProp3": "string"
}
}
É possível configurar um header customizado no seu webhook, além de múltiplos webhooks por usuário de apikey, permitindo separar os pontos de extremidado pelos types, por exemplo.
Atenção:será necessário criar um ponto de extremidade no seu servidor para receber notificações.
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.
Campos de assinatura disponíveis
Atualmente somente o webhook messages está disponível.
Campos de assinatura
| 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, umaviolaçã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 |