🪝Webhooks

Comment utiliser les Webhooks afin de connecter vos systèmes informatiques à nos évènements pour échanger des données.

Introduction

Un Webhook est un point de terminaison HTTPS (URL) qui reçoit des événements de la part de KohortPay.

Les webhooks vous permettent d'être informé des événements qui se produisent tout au long du cycle de paiement ou de parrainage. Voici la liste des évènements disponible :

• payment_intent.created : Lorsque la session de paiement démarre (aucun moyen de paiement n'a été défini)

• payment_intent.canceled : Lorsque le paiement est annulé

• payment_intent.succeeded : Lorsque le paiement a débloqué un cashback

• payment_intent.cashback_sent : Lorsqu'un cashback a été envoyé pour le paiement

• payment_group.created : Lorsqu'un kohort est créé

• payment_group.expired : Lorsque le temps pour inviter est terminé

• payment_group.joined : Lorsqu'un client rejoint un kohort

• payment_group.succeeded : Lorsqu'un kohort a débloqué un cashback

A chaque fois qu'évènement se produit, nous envoyons les données correspondante sous format JSON au point de terminaison HTTPS (URL) configuré.

La liste de vos Webhooks

Vous pouvez consulter la liste de vos Webhook depuis notre Dashboard dans la section Configuration > Développeur > Webhook (https://dashboard.kohortpay.com/live/settings/developer).

Voice les informations dont nous vous mettons à disposition :

• La date de création du Webhook.

• L'URL où nous envoyons les données concernant les évenements.

• Le status du Webhook. ⚠️Si il est désactivé, vous ne recevrez plus d'information de notre part.

• Enfin le taux d'erreur. ⚠️Veuillez faire attention qu'il soit le plus proche de 0%.

Création d'un Webhook

Au même emplacement que la liste de vos webhook, dans la section Configuration > Développeur > Webhook (https://dashboard.kohortpay.com/live/settings/developer), vous trouverez un bouton à droite "Créer un webhook". Une fois cliqué dessus, vous devez renseigner les informations suivantes :

• URL : Le point de terminaison HTTPS qui va recevoir les données des évènements.

• Description : Une description pour mieux identifier et comprendre quel est objectif de votre webhook.

• Evènements : Liste des évènement auxquels vous souhaitez souscrire pour cette URL uniquement. Vous pouvez souscrire à un ou plusieurs évenements. ⚠️Si plusieurs, veuillez bien faire attention a gérer tous les cas dans votre code.

Editer un Webhook

A tout moment, vous pouvez éditer un webhook. Pour cela, il suffit de cliquer sur la ligne de votre Webhook depuis la liste des Webhooks dans la section Configuration > Développeur > Webhook (https://dashboard.kohortpay.com/live/settings/developer). Une fois sur la page de détails du Webhook, vous pouvez lancer les actions suivants via le bouton en haut à droite de l'écran :

• Désactiver ou Activer votre webhook. ⚠️Si il est désactivé, vous ne recevrez plus d'information de notre part.

• Editer les informations du webhook comme l'URL, la description ou les liste des évènements souscrit.

• Renouveler votre clé secrète. ⚠️Cette clef ne doit pas être partagé publiquement, elle permet d'assurer que le message que vous avez reçu provient bien de notre système.

• Enfin supprimer définitivement le webhook.

Activités du Webhooks

Depuis la page de détail du Webhook, vous pourrez suivre toutes les activités (logs).

Ceci vous permet d'analyser ce qu'il s'est passé, vous pouvez voir et filtrer les activités échoués et comprendre pourquoi gràce à la partie de droite qui affichera la réponse et la requête que nous avons envoyé.

Une fois que vous avez corrigé l'erreur, vous pouvez renvoyer manuellement l'activité via le bouton en haut à droite, ce qui re-déclenchera l'évènements et vous renverra les données sur votre URL.