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.

Dans la version 4.0 du webhook, les références site et d'enregistrement sont de simples identifiants. Les versions antérieures envoient plutôt un objet contenant les identifiants externes destinés au marchand; un site migré vers la version 4.0 verra donc cette structure changer.

Le champ message est une phrase lisible par un humain plutôt qu'un code, et sa formulation ne fait pas partie du contrat de l'API. Les mises à jour de livraison indiquent ce qui a été envoyé, à qui et le nouveau statut, comme dans « Payment Request to customer@example.com delivered », où le statut est l'un des suivants : sent, delivered, read, delayed ou failed. Les mises à jour de clic se lisent « Customer clicked the text link ». Basez la logique de votre intégration sur la valeur booléenne error et sur les identifiants d'enregistrement, et non sur la formulation.

Notification de livraison ou de clic

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

Échec de la notification

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