Utilisez les webhooks lorsque votre système doit être informé des paiements et des messages dès qu'ils surviennent, plutôt que d'interroger Hyfin sans cesse.
Les webhooks permettent à Hyfin d'informer votre système des changements en temps réel, sans que vous ayez à vérifier constamment. Une fois activés, Hyfin envoie un message à votre URL dès qu'un événement se produit.
Vous activez les webhooks pour un site entier ou pour une facture en envoyant une URL de webhook au point de terminaison correspondant. Voici le JSON dont chaque point de terminaison a besoin.
{
"external_id": "12345678",
"webhook": {
"active": true,
"url": "https://mysoftware.com/webhook"
}
}
{
"external_id": "39772921",
"webhook_url": "https://mysoftware.com/webhook/{invoice_id}"
}
Lorsqu'une URL de webhook est définie, Hyfin envoie les messages suivants.
L'URL de votre webhook doit répondre avec un code d'état HTTP de réussite (tout code 2xx) en moins de 30 secondes. Un état autre que 2xx, un délai d'attente dépassé ou une connexion impossible à établir est considéré comme un échec de livraison, et le message est renvoyé selon le calendrier suivant.
Il y a au plus cinq tentatives de nouvel envoi. Chaque délai du tableau est mesuré à partir de la tentative précédente plutôt qu'à partir du webhook initial; la cinquième et dernière tentative a donc lieu environ 3,1 jours après celui-ci. Si cette tentative échoue aussi, le message n'est plus renvoyé.