Créer et gérer des abonnements aux webhooks Advocate

Les webhooks sont du code qui s’exécute lorsqu’un événement se produit. Advocate vous permet d’utiliser des webhooks pour enregistrer une URL vers laquelle nous effectuerons une requête POST chaque fois qu’un événement se produit dans votre programme, par exemple lorsqu’un code de coupon personnalisé est créé pour un nouveau participant, un objet événement est créé. Il existe deux méthodes pour créer et gérer des webhooks : via l’API Advocate ou dans la plateforme Advocate. Cet article d’aide explique comment gérer les webhooks via la plateforme Advocate.

Créer un abonnement au webhook

1. Dans la barre de navigation supérieure, sélectionnez [Profil utilisateur] → Paramètres.

2. Dans la colonne de gauche ci-dessous Paramètres Advocate, sélectionnez Webhooks.

3. Dans la Abonnements aux webhooks page, sélectionnez Créer un abonnement.

4. Ci-dessous Publier vers l’URL, saisissez l’adresse unique utilisée par l’application pour envoyer des mises à jour en temps réel sur des événements spécifiques.

5. Facultativement, sous Nom du webhook, saisissez le nom du nouvel abonnement au webhook.

6. Sélectionnez Enregistrer.

Résoudre les journaux de webhooks

Lorsque vous enregistrez une URL vers laquelle Advocate effectue une requête chaque fois qu’un événement se produit dans votre programme, vous pouvez consulter les journaux et résoudre les problèmes liés aux événements de webhook qui échouent.

Accéder à vos journaux de webhooks

1. Dans la barre de navigation supérieure, sélectionnez [Profil utilisateur] → Paramètres.

2. Dans la colonne de gauche ci-dessous Paramètres Advocate, sélectionnez Webhooks.

3. Dans la Abonnements aux webhooks page, sélectionnez Afficher les journaux.

4. Utilisez les filtres ci-dessous Journal des événements des webhooks pour filtrer les webhooks.

   • Reportez-vous à la Référence des filtres ci-dessous pour plus d’informations.

Référence des filtres

Filtre	Description
Type	Filtrer par webhook type d’événement. Ce filtre est défini par défaut sur Tous les types.
Période	Filtrer pour la période au cours de laquelle le webhook a été mis à jour pour la dernière fois. Ce filtre est défini par défaut sur Toute la période.

Afficher les détails du webhook

1. Sélectionnez un webhook spécifique pour ouvrir la vue Détails du webhook .

2. Cette vue fournit des informations qui peuvent être utilisées pour résoudre un problème lié à un abonnement au webhook.

   • Reportez-vous à la Référence de l’événement ci-dessous pour plus d’informations.

Référence de l’événement

Filtre	Description
Type	Le webhook type d’événement.
ID du webhook	L’identifiant unique du webhook.
Date de création	La date à laquelle le webhook a été créé.
Données de l’événement	Le webhook charge utile.
Abonnement(s)	Abonnements aux webhooks auxquels le webhook a été envoyé et leur statut.
Détails de l’abonnement	Détails concernant la réponse reçue depuis le point de terminaison de l’abonnement au webhook. Les détails peuvent inclure la tentative de livraison du webhook, indiquant l’horodatage de la tentative, le code d’état HTTP reçu de la destination, et si la tentative a expiré parce que la requête a mis trop de temps à recevoir une réponse du serveur de destination.

Système de nouvelle tentative des webhooks pour les livraisons d’événements échouées

• Les webhooks sont livrés immédiatement après le déclenchement d’un événement. Si le point de terminaison ne répond pas correctement à une tentative de livraison (c.-à-d. qu’il ne renvoie pas un code d’état autre que 200), la livraison sera considérée comme échouée.

• Les livraisons échouées seront retentées toutes les heures après la précédente tentative échouée jusqu’à ce qu’une livraison réussie soit effectuée ou jusqu’à ce que 72 tentatives aient été effectuées (environ 3 jours au rythme d’une nouvelle tentative par heure).

• Les points de terminaison de webhook qui renvoient systématiquement des erreurs seront automatiquement désactivés après le nombre d’erreurs suivant :

  Code d’état	Erreurs reçues
  Erreurs 4xx	1000
  Erreurs 5xx	2000
  Erreurs 3xx	2000