Configuration des webhooks

Configuration des webhooks

Ajouter ou modifier l’URL, sélectionner les événements à envoyer et sauvegarder la configuration — reload de l’app inclus

Maîtrisez l’envoi d’événements depuis votre application vers vos endpoints externes : configuration d’URL, sélection fine des événements, test et vérification des payloads.

Fonctionnalités couvertes

Configurer l'URL du webhook

Saisir ou modifier l’URL de réception (préférer HTTPS), valider l’accessibilité et préparer l’environnement de réception.

Choisir les événements à envoyer

Activer ou désactiver des catégories et sous-événements pour réduire le bruit et améliorer la réactivité.

Tester et nettoyer les payloads

Sélectionner un événement historique, visualiser et “nettoyer” le JSON si nécessaire, copier le payload pour vos tests.

Sauvegarder (reload de l'app)

Sauvegarde appliquée à la configuration de l’application ; la mise à jour déclenche le rechargement de la configuration.

Historique & diagnostics

Consulter les envois récents, codes de statut et messages d’erreur pour diagnostiquer les problèmes.

Chargement progressif des événements

Parcours des événements plus anciens via “Charger plus” pour reproduire et tester des cas passés.

Introduction

Ce guide explique pas à pas comment ajouter ou modifier un webhook, sélectionner précisément quels événements doivent être transmis, tester les envois et enregistrer la configuration. Il inclut des bonnes pratiques, conseils pour dépanner, et des scénarios pour production et test.

Avant de commencer

Préparez l’URL de destination (HTTPS de préférence), un endpoint de test (ex. webhook tester en ligne ou environnement de pré-production) et une petite liste d’événements prioritaires que vous souhaitez capter. Cela accélère la configuration et les tests.

Workflow : Ajouter un nouveau webhook (URL)

1

Étape 1 — Accéder à la page Webhooks

Ouvrez la section “Clés API & Webhooks” puis l’onglet “Webhooks” (ou “Webhook” selon l’interface). Vous devriez voir un champ URL et la liste des événements récents.

2

Étape 2 — Saisir l’URL

Collez l’URL complète de votre endpoint : commencez par https:// si possible. Vérifiez l’absence d’espaces ou de caractères non valides. Si votre endpoint nécessite un chemin précis, incluez-le.
Note technique : le champ d’URL est maintenant validé côté interface pour correspondre au schéma en base de données — le schéma (http:// ou https://) doit être présent, aucun espace n’est autorisé, et la longueur maximale acceptée par l’interface est étendue (jusqu’à 2048 caractères pour les URLs longues). Le backend accepte désormais des URLs plus longues et complexes (reliquat de requêtes longues ou parametrées). :

3

Étape 3 — Options d’authentification (si disponibles)

Si votre endpoint attend un header d’authentification ou un token, configurez-le côté destinataire. Notez : l’interface peut ne pas envoyer d’en-têtes personnalisés automatiquement — configurez la protection côté serveur (ex. clé dans header). :

4

Étape 4 — Valider l’accessibilité

Avant d’enregistrer, testez que l’URL est joignable (ouvrir l’URL dans un onglet ne suffit pas toujours — utilisez un outil de test webhooks ou envoyez une requête d’essai depuis votre environnement de test). Si votre URL contient de longs paramètres ou des chaînes encodées, vérifiez aussi que le serveur destinataire accepte ces longueurs et formats. :

5

Étape 5 — Enregistrer provisoirement

Après vérification, gardez la page ouverte et passez à la sélection des événements (voir workflows ci‑dessous). La sauvegarde finale est traitée dans la section « Sauvegarder la configuration ».

Workflow : Modifier une URL de webhook existante

1

Étape 1 — Ouvrir la configuration existante

Repérez la ligne ou le champ contenant l’URL actuelle et cliquez sur modifier (ou placez le curseur dans le champ). :

2

Étape 2 — Mettre à jour l’URL

Remplacez l’URL par la nouvelle, vérifiez le format (HTTPS recommandé) et corrigez tout slash en doublon. Rappel : l’interface appliquera les mêmes validations que la base (présence du schéma, pas d’espaces, longueur maximale étendue — jusqu’à 2048 caractères); adaptez l’URL en conséquence. :

3

Étape 3 — Tester la réception

Utilisez un événement connu dans la liste des événements récents (sélectionnez-le et copiez son payload) pour simuler un envoi vers la nouvelle URL. :

4

Étape 4 — Vérifier les logs/retours

Regardez la colonne statut et le message d’erreur (le cas échéant) pour confirmer que le nouvel endpoint répond comme attendu. :

5

Étape 5 — Sauvegarder

Cliquez sur “Enregistrer” pour appliquer la modification. Notez que la sauvegarde provoque le rechargement de la configuration applicative (voir avis ci‑dessous).

Workflow : Choisir quels événements envoyer

1

Étape 1 — Lire la liste des événements disponibles

La page affiche des événements récents regroupés par date. Parcourez la liste pour repérer les types d’événements pertinents. :

2

Étape 2 — Charger plus d’événements si nécessaire

Si votre cas d’usage nécessite de reproduire un incident ancien, utilisez le bouton “Charger plus” (ou équivalent) pour récupérer des événements plus anciens. :

3

Étape 3 — Activer/désactiver des catégories

Activez uniquement les catégories nécessaires (ex. paiements, abonnements, erreurs). Moins d’événements = moins de trafic et plus de lisibilité. :

4

Étape 4 — Gérer les sous-événements

Certaines catégories proposent des sous-événements (ex. types d’actions précises). Cochez ou décochez au niveau fin pour éviter l’envoi d’informations redondantes. :

5

Étape 5 — Sauvegarder les choix

Après avoir défini la sélection, sauvegardez (voir section suivante). Vérifiez ensuite le flux d’événements entrants côté destinataire. :

6

Étape 6 — Tenir compte des validations d’URL

Lorsque vous modifiez à la fois l’URL et la sélection d’événements, gardez en tête que les validations d’URL (schéma, longueur, caractères) sont appliquées côté UI avant enregistrement pour éviter des erreurs au moment du sauvegarde. :

Workflow : Tester un webhook et nettoyer un payload

1

Étape 1 — Sélectionner un événement existant

Dans la liste d’historique, cliquez sur un événement pour l’afficher. Vous verrez le payload et, le cas échéant, le message d’erreur renvoyé par le destinataire. :

2

Étape 2 — Nettoyer le JSON si besoin

Les payloads peuvent contenir des champs JSON encodés sous forme de chaînes. Utilisez l’option “nettoyer” (cleanJson) ou collez le texte dans un éditeur JSON pour dé‑double‑encoder les champs. Cela rend le payload lisible et exploitable. :

3

Étape 3 — Copier le payload

Cliquez sur “Copier le payload” pour récupérer le JSON formaté (ou sur “Copier le message d’erreur” si vous déboguez une erreur). :

4

Étape 4 — Reproduire l’envoi vers votre endpoint de test

Utilisez un outil de test (webhook tester en ligne, client HTTP, ou votre environnement de pré-prod) et collez le payload pour simuler l’envoi. Vérifiez la réponse HTTP et les logs côté destinataire. :

5

Étape 5 — Interpréter la couleur de statut

Les statuts ont des repères visuels : vert = réussite, bleu = redirection/info, jaune = client error, rouge = erreur serveur. Utilisez ces indices pour prioriser le dépannage.

Limiter la portée pour débuter

Commencez par activer un petit sous‑ensemble d’événements (par ex. erreurs critiques et paiements) pour valider la chaîne de réception. Une fois stable, élargissez progressivement.

Workflow : Sauvegarder la configuration (et gérer le reload)

1

Étape 1 — Vérifier l’URL et les événements choisis

Relisez l’URL, la sélection d’événements et vos tests précédents. Assurez‑vous que l’URL ne crée pas de boucles (ex. renvoi vers la même application). Note technique : la structure du champ en base de données a été mise à jour pour accepter des URLs plus longues et complexes — l’interface applique donc les mêmes validations avant l’enregistrement (schéma requis, pas d’espaces, longueur maximale étendue). :

2

Étape 2 — Cliquer sur « Enregistrer »

Appuyez sur le bouton d’enregistrement. Un indicateur de chargement s’affiche pendant l’opération. :

3

Étape 3 — Attendre la confirmation

Une notification confirme la sauvegarde (ex. “Modification du webhook enregistrée”). La configuration applicative est alors rechargée pour prendre effet. :

4

Étape 4 — Vérifier après reload

Après le rechargement, contrôlez l’historique des événements récents pour vérifier que les envois se poursuivent vers la nouvelle URL et que les codes de statut sont corrects. :

5

Étape 5 — Informer l’équipe si nécessaire

Si vous travaillez en équipe, prévenez les personnes impactées du bref reload et des changements appliqués.

Attention au reload et aux environnements

La sauvegarde applique la configuration à l’ensemble de l’application et provoque un rechargement de la configuration. Ne sauvegardez pas en production sans coordination si vous prévoyez des tests perturbateurs. Évitez d’indiquer des URL locales non exposées (localhost/tunnel instable) pour les webhooks de production.

  • Limitez les événements aux plus utiles (paiements, factures, erreurs critiques).
  • Utilisez une URL HTTPS publique, capacité à gérer des pics, authentification côté serveur (clé, signature HMAC).
  • Activez la journalisation des réponses et codes de statut.
  • Tests : synchronisez un test en staging avant basculer en prod.
  • Autorisez plus d’événements pour reproduire les flux complets.
  • Utilisez un service de capture (webhook tester) ou un endpoint de pré-prod accessible uniquement à votre équipe.
  • Nettoyez les payloads avant leur ingestion pour éviter les erreurs liées aux champs JSON encodés en string.

Avant : pas de webhook ou trop d’événements activés

  • Surflux d’envois non pertinents
  • Difficile à dépanner
  • Risque de dépassement ou traitement lent

Après : webhook ciblé et testé

  • Moins de trafic, plus lisible
  • Tests reproductibles avec payloads nettoyés
  • Déploiement sécurisé et contrôlé (reload connu)

Sécurité et idempotence

Préparez votre endpoint pour être idempotent : si le même événement est renvoyé, il doit être géré sans créer d’effets secondaires multiples. Ajoutez une vérification d’origine (signature ou token) et limitez la durée de rétention des payloads sur votre côté.

Boucles et volumes inattendus

Évitez les boucles où le destinataire renvoie un événement à la même application — cela peut générer des envois infinis. De même, activer tous les événements peut engendrer un volume important et augmenter les délais de traitement.

Frequently Asked Questions

Prêt à configurer vos webhooks ?

Si vous avez tout préparé (URL, endpoint de test, liste d’événements), rendez‑vous dans la rubrique Clés API & Webhooks pour appliquer la configuration et lancer vos premiers tests.

Remarques finales

  • Toujours tester dans un environnement restreint avant une mise en production complète.
  • Préférez HTTPS, sécurisez l’endpoint par une signature ou un token, et limitez la consommation d’événements pour éviter les surcharges.
  • Utilisez la fonctionnalité de nettoyage des payloads pour garantir une inspection et une ingestion fiables des données envoyées.
Sinao

Le logiciel de comptabilité simple et puissant. Prenez la main sur vos finances, votre trésorerie et documents pour piloter votre entreprise.

Powered by DeployIt

© 2026 Sinao