Créer et gérer les 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 enverrons une requête POST chaque fois qu'un événement se produit dans votre programme ; par exemple, lorsqu'un code promo 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 explique comment gérer les webhooks via la plateforme Advocate.

Créer un abonnement 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. Sur la Abonnements aux webhooks page, sélectionnez Créer un abonnement.
4. Ci-dessous Publier vers l'URL, saisissez l'adresse unique que l'application utilise pour envoyer des mises à jour en temps réel sur des événements spécifiques.
5. Facultativement, ci-dessous Nom du webhook, saisissez le nom du nouvel abonnement webhook.
6. Sélectionnez Enregistrer.

Dépanner les journaux des webhooks

Lorsque vous enregistrez une URL vers laquelle Advocate envoie des données à chaque fois qu'un événement se produit dans votre programme, vous pouvez consulter les journaux et dépanner les événements webhook qui échouent.

Accédez à 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. Sur la Abonnements aux webhooks page, sélectionnez Voir 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 la période lors 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.

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 un abonnement 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 webhook auxquels le webhook a été envoyé et leur état.
Détails de l'abonnement	Détails sur la réponse reçue du point de terminaison de l'abonnement 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 rest hooks 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'est-à-dire 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éussisse ou que 72 tentatives aient été effectuées (environ 3 jours à raison d'1 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