Webhooks > Introduction

Webhooks are a great way for your system to receive near real-time updates from The Invoice Path without the need to constantly polling. When enabled, your system will be notified as soon as an event is trigger within The Invoice Path.

Activation des webhooks

Webhooks can be enabled on a per site or per invoice basis by assigning a webhook URL when calling the associated endpoints. Here is an example of the json data required to enable webhooks for each endpoint.

Point de terminaison

Échantillon JSON

Add/Update Site

When adding or editing a new site, you can enable a webhook at the site level. If a site level webhook is enabled you will receive all invoice and payment notifications for the site.

			
{
  "externalId": "12345678",
  "webhook": {
    "active": true,
    "url": "https://mysoftware.com/webhook"
  }
}

Add/Update Invoice

When adding or editing an invoice, you can enable a webhook at the invoice level and you will receive all notifications related to the invoice.

			
{
  "externalId": "39772921",
  "webhookUrl": "https://mysoftware.com/webhook/{invoice_id}"
}

Événements de webhook

When a webhook URL is configured, the following messages will be sent.

Action

Détail

Paiement

Un paiement sur une facture atteint un nouveau statut, par exemple capturé, réglé, annulé, remboursé ou faisant l'objet d'une rétrofacturation. Chaque statut est envoyé une seule fois par paiement.

Notification

Un message texte ou un courriel a changé d'état de livraison (envoyé, livré, lu, retardé ou échoué), ou le client a cliqué sur le lien de paiement.

Tentatives

Your webhook URL must answer with a successful HTTP status code (any 2xx) and should do so within 10 seconds. A non-2xx status, or a connection that cannot be made at all, counts as a failed delivery and the message is re-sent using the following schedule.

Tentative de réessai

Renvoyé

5 minutes après le webhook initial

1 heure plus tard

2 heures plus tard

Il y a au plus trois tentatives de renvoi. Chaque délai du tableau est calculé à partir de la tentative précédente plutôt qu'à partir du webhook initial; la troisième et dernière tentative est donc effectuée environ trois heures plus tard. Si celle-ci échoue également, le message n'est plus renvoyé.