A API do Webhook do Engage é uma ferramenta que permite que você receba notificações em tempo real sobre eventos relacionados a alterações no status das mensagens no Engage. Ela ajuda os usuários a se manterem atualizados sobre o status de suas mensagens e a acompanhar cada entrega, podendo aplicar ações com base nas informações recebidas.
Quando uma mensagem muda de status, por exemplo, de "enviada" para "recebida", a API notificará o URL do webhook que você configurou. A notificação conterá informações relevantes sobre a mensagem, como seu ID e o novo status.
Exemplo de corpo de mensagem enviado pela API quando o status da mensagem é alterado:
{
"message_id": "wamid.HBgMMzU5ODg0NjE4MTgAERgSTMwMTQ5ODY1NTFERUY0AA==",
"message_status": "delivered",
"channel": {
"channel_type": "Whatsapp",
"name": "Channel Name",
"sender_id": "Channel sender id value" // sender’s phone number
},
"campaign": {
"id": "074116ff-76f3-47b7-8be2-92f465718a3e",
"name": "campaign name"
},
"event_name": "msg_status",
"event_timestamp": "1687548944",
"recipient": {
"id": "541112341234" // recipient’s phone number
}
}
</code>
* Os status disponíveis na API do Webhook do Engage serão observados no item msg_status e são: enviado, entregue, lido e erro.
Você pode solicitar uma assinatura dos webhooks de status de mensagem enviando um tíquete para o centro de suporte da Aivo.
No tíquete, você deve indicar 
- O número de telefone de saída que você deseja assinar.
- Se você precisa receber notificações de status de mensagens de campanhas únicas ou recorrentes para esse número.
- O URL de seu serviço que receberá os webhooks.
- Se você tiver algum cabeçalho de autenticação, digite o nome do cabeçalho.
- O valor correspondente. Por exemplo: "x-auth-token", "kjhasdc8a7dsckjabdckjabdckasdyc8".