Créer et gérer des abonnements webhook 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 à laquelle nous enverrons des requêtes POST chaque fois qu’un événement se produit dans votre programme, par exemple lorsqu’un code 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 les webhooks : via l’API Advocate ou dans la plateforme Advocate. Cet article d’aide expliquera comment gérer les webhooks via la plateforme Advocate.

Créer une souscription webhook

1. Depuis 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. Sur le Souscriptions Webhook page, sélectionnez Créer une souscription.

4. Ci-dessous Poster vers l’URL, saisissez l’adresse unique que l’application utilise pour envoyer des mises à jour en temps réel concernant des événements spécifiques.

5. Facultativement, ci‑dessous Nom du Webhook, saisissez le nom de la nouvelle souscription webhook.

6. Sélectionnez Enregistrer.

Dépanner les journaux webhook

Lorsque vous enregistrez une URL à laquelle Advocate publie chaque fois qu’un événement se produit dans votre programme, vous pouvez consulter les journaux et dépanner tout événement webhook qui échoue.

Accéder à vos journaux webhook

1. Depuis 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. Sur le Souscriptions Webhook page, sélectionnez Voir les journaux.

4. Utilisez les filtres ci‑dessous Journal des événements 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 pour le webhook type d’événement. Ce filtre est défini par défaut sur Tous les types.
Période	Filtrer par période durant 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.

Voir les détails du webhook

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

2. Cette vue fournit des informations pouvant être utilisées pour dépanner une souscription 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.
Souscription(s)	Souscriptions webhook auxquelles le webhook a été envoyé et leur statut.
Détails de la souscription	Détails concernant la réponse reçue depuis le point de terminaison de la souscription 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 par 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 hooks REST sont livrés immédiatement après le déclenchement d’un événement. Si le point de terminaison ne répond pas avec succès à une tentative de livraison (c’est‑à‑dire répond avec 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 tentative échouée précédente 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 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