Configurer les tentatives de renvoi pour les Webhooks
Configurer les tentatives de renvoi pour les Webhooks
Quand un webhook échoue (service externe indisponible, erreur HTTP), Dokos peut le renvoyer plus tard. Les renvois sont espacés de plus en plus. Chaque envoi et chaque renvoi est suivi dans le Journal de la demande de Webhook.
Prérequis
- Avoir accès au document Webhook (rôle Responsable système en général).
- Le planificateur du site doit être actif : une tâche planifiée lance les renvois toutes les 5 minutes.
Régler le nombre de tentatives
- Ouvrez le webhook.
- Saisissez le Nombre de tentatives : le nombre de renvois après le premier échec. La valeur par défaut est 3. La valeur 0 désactive les renvois.
- Enregistrez.
Calendrier des renvois
| Renvoi | Délai après l'échec précédent |
|---|---|
| 1er | 5 minutes |
| 2e | 30 minutes |
| 3e | 2 heures |
| 4e | 5 heures |
| 5e et suivants | 10 heures |
La tâche planifiée passe toutes les 5 minutes. Un renvoi part donc au plus 5 minutes après l'heure prévue.
Ce qui se passe à chaque envoi
- Le premier envoi échoue. Si le Nombre de tentatives vaut au moins 1, le journal passe au statut Échec et le champ Prochaine tentative reçoit la date du renvoi. Sinon, le journal passe au statut Épuisé.
- Dokos renvoie la même URL, les mêmes en-têtes et les mêmes données que le premier envoi. Les modifications faites au document entre-temps ne sont pas envoyées.
- Si le renvoi réussit, le journal passe au statut Livré.
- Si tous les renvois échouent, le journal passe au statut Épuisé. Dokos n'essaie plus.
Si le webhook est désactivé avant un renvoi, le journal passe directement au statut Épuisé.
Suivre les renvois
Ouvrez la liste Journal de la demande de Webhook (recherche Ctrl+K). Filtrez sur le Webhook et le Statut.
| Champ | Contenu |
|---|---|
| Statut | Livré, Échec (un renvoi est prévu) ou Épuisé. |
| Tenter | Numéro de la dernière tentative. |
| Prochaine tentative | Date et heure du prochain renvoi. Vide quand aucun renvoi n'est prévu. |
| Réponse, Erreur | Réponse du service externe et trace de la dernière erreur. |
| URL, En-Têtes, Données | Contenu de la requête, réutilisé à chaque renvoi. |
Si le webhook a l'option Activer la sécurité, la signature HMAC (en-tête X-Frappe-Webhook-Signature) est conservée dans les en-têtes. Le service externe peut donc la vérifier aussi lors d'un renvoi.
Exemple
Exemple fictif. Un webhook envoie chaque nouvelle commande client à un logiciel de préparation. Le Nombre de tentatives vaut 3. Le logiciel est en maintenance de 9 h 00 à 10 h 30.
| Heure | Événement | Statut du journal |
|---|---|---|
| 9 h 00 | Premier envoi, échec | Échec, prochaine tentative 9 h 05 |
| 9 h 05 | 1er renvoi, échec | Échec, prochaine tentative 9 h 35 |
| 9 h 35 | 2e renvoi, échec | Échec, prochaine tentative 11 h 35 |
| 11 h 35 | 3e renvoi, succès | Livré |
Si le logiciel était resté indisponible, le journal serait passé au statut Épuisé après le 3e renvoi.