Temps de lecture estimé : 3 min · Publié le 1 octobre 2026
Écrire le contrat de l’événement
Documentez le producteur, les événements réellement attendus, les champs nécessaires et l’opération déclenchée. Indiquez le résultat attendu pour une création, une modification et une suppression lorsque ces états existent. Une notification ne doit pas être interprétée comme une commande implicite pour toutes les actions possibles.
Choisissez un identifiant de suivi et la source de référence à consulter en cas d’incertitude. Décrivez comment une erreur du producteur ou du destinataire sera constatée. Le dossier d’intégration contient les règles et responsables ; les secrets restent dans le mécanisme sécurisé prévu par le projet.
Vérifier avant de déclencher une action
La documentation GitHub décrit la validation de signature d’une livraison à partir du secret configuré et du contenu reçu. Suivez le mécanisme documenté du fournisseur concerné : les en-têtes, algorithmes et formats ne doivent pas être copiés d’un autre service par analogie.
Séparez validation de l’origine, validation du schéma et autorisation de l’action. Préparez des essais pour un contenu altéré, un type d’événement inattendu et un champ absent. Le traitement métier ne doit démarrer qu’après les contrôles nécessaires au cas d’usage.
Prévoir répétitions et interruptions
Proposez une règle d’idempotence : une même livraison reconnue ne doit pas produire deux commandes ou deux notifications définitives. Testez une répétition avant, pendant et après le traitement, ainsi qu’un arrêt entre deux étapes. Le mécanisme choisi dépend du stockage et de l’opération concernés.
Examinez les garanties d’ordre et de nouvelle livraison du fournisseur au lieu de supposer que tous les événements arrivent immédiatement et une seule fois. Préparez une liste des traitements à vérifier et un moyen de rapprochement avec la source. Une réponse technique positive doit correspondre à un état de traitement défini.
Organiser la surveillance et la reprise
Consignez un identifiant d’événement, un état et une erreur utile en minimisant les données. Définissez qui surveille les échecs, comment relancer un événement autorisé et comment empêcher une relance de dupliquer une opération déjà terminée.
Dans l’environnement d’essai, interrompez le destinataire puis rétablissez-le. Vérifiez le rattrapage et comparez les résultats métier attendus. Le livrable est un contrat d’événement accompagné d’un lot de tests, d’un historique de traitement et d’une procédure de reprise utilisable par l’équipe.
Documentation primaire : GitHub — Validating webhook deliveries.