Webhooks > Notification

Este webhook se llama en cada evento de notificación de un mensaje de texto, correo electrónico o mensaje de WhatsApp vinculado a una solicitud de pago o a una suscripción: cuando se envía, se entrega, se lee, se retrasa o falla, y cuando el cliente hace clic en el enlace de pago. El siguiente formato de datos se enviará por POST a la URL del webhook proporcionada.

En la versión 4.0 del webhook, site y las referencias a registros son ids simples. Las versiones anteriores envían en su lugar un objeto con los ids externos visibles para el comercio, por lo que un sitio que pase a la 4.0 verá cambiar esta estructura.

El campo message es una oración legible para personas y no un código, y su redacción no forma parte del contrato de la API. Un envío se lee como "Payment Request sent to customer@example.com", una actualización de estado posterior como "Sms to +15555550100 delivered" y un clic como "Customer clicked the text link". Base la lógica de su integración en el booleano error y en los ids de los registros, no en la redacción.

Eventos de notificación

Cada uno de estos eventos envía su propio webhook. La carga no nombra el evento: error es true para una entrega fallida o parcialmente fallida y false para cualquier otro evento, y message describe el evento para que lo lean las personas.

			
{
  "action": "notification",
  "data": {
    "site": "6201825a0cf5e23261a08646",
    "invoice": "649dc5bb468bd5b5d863c7d2",
    "message": "Customer clicked the text link",
    "error": false
  }
}


		

			
{
  "action": "notification",
  "data": {
    "site": "6201825a0cf5e23261a08646",
    "invoice": "649dc5bb468bd5b5d863c7d2",
    "message": "Text to 18001231245 failed",
    "error": true
  }
}