La API Webhook de Engage es una herramienta que permite recibir notificaciones en tiempo real sobre eventos relacionados con cambios en el estado de los mensajes en Engage. Ayuda a los usuarios a mantenerse actualizados sobre el estado de sus mensajes y realizar un seguimiento de cada envío, pudiendo aplicar acciones basadas en la información recibida.
Cuando un mensaje cambia de estado, por ejemplo, de "enviado" a "recibido", la API lo notificará a la URL del webhook que configures. El aviso contendrá información relevante sobre el mensaje, como su ID y el nuevo estado.
Ejemplo de cuerpo de mensaje enviado por la API al cambiar el estado del mensaje:
{ "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 } } |
* Los estados disponibles en la API Webhook de Engage, se observarán en el ítem msg_status y son: sent (enviado), delivered (entregado), read (leído) y error (error).
Puedes solicitar la suscripción a webhooks de estado de mensajes a través de un requerimiento en Aivo support center.
Dentro del ticket debes indicar
- El número de teléfono saliente que deseas suscribir.
- Si necesitas recibir las notificaciones de estado de mensajes de campañas One-time o Recurrent para ese número.
- La URL de su servicio que recibirá los webhooks.
- Si tienes algún header de autenticación, escribe el nombre del header.
- El valor correspondiente. Ej.: “x-auth-token”, “kjhasdc8a7dsckjabdckasdyc8”.