Webhooks > Notification

This webhook is called whenever a text message or email attached to a payment request or a subscription changes delivery state, and whenever the customer clicks the payment link. The following data format will be POSTED to the provided webhook URL.

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. Las actualizaciones de entrega indican qué se envió, a quién y el nuevo estado, como en "Payment Request to customer@example.com delivered", donde el estado es uno de sent, delivered, read, delayed o failed. Las actualizaciones de clic se leen 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.

Notificación de entrega o clic

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

Notificación fallida

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