Version de développement
Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.
Intégrations

Configurer les tentatives de renvoi pour les Webhooks

Régler le nombre de tentatives de renvoi d'un webhook en échec, comprendre le calendrier des renvois et suivre chaque tentative dans le journal.

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

  1. Ouvrez le webhook.
  2. 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.
  3. Enregistrez.

Calendrier des renvois

RenvoiDélai après l'échec précédent
1er5 minutes
2e30 minutes
3e2 heures
4e5 heures
5e et suivants10 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

  1. 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é.
  2. 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.
  3. Si le renvoi réussit, le journal passe au statut Livré.
  4. 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é.

Un webhook déclenché par une transition de workflow n'est jamais renvoyé. La transition attend le résultat : en cas d'échec, elle échoue aussi et le journal passe 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.

ChampContenu
StatutLivré, Échec (un renvoi est prévu) ou Épuisé.
TenterNuméro de la dernière tentative.
Prochaine tentativeDate et heure du prochain renvoi. Vide quand aucun renvoi n'est prévu.
Réponse, ErreurRéponse du service externe et trace de la dernière erreur.
URL, En-Têtes, DonnéesContenu 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énementStatut du journal
9 h 00Premier envoi, échecÉchec, prochaine tentative 9 h 05
9 h 051er renvoi, échecÉchec, prochaine tentative 9 h 35
9 h 352e renvoi, échecÉchec, prochaine tentative 11 h 35
11 h 353e renvoi, succèsLivré

Si le logiciel était resté indisponible, le journal serait passé au statut Épuisé après le 3e renvoi.