Passer au contenu principal
Un webhook notifie votre endpoint lorsque des événements se produisent dans Bodyguard, comme la mise à jour d’un message ou d’un auteur. Cette page vous guide pour en enregistrer un dans le dashboard. Pour comprendre le fonctionnement des webhooks, consultez l’introduction aux webhooks.

​
Prérequis

Vous avez besoin d’un endpoint HTTPS public, prêt à recevoir des notifications. Bodyguard refuse les webhooks enregistrés avec une URL http. Consultez le Démarrage rapide pour créer votre endpoint et vérifier la signature de chaque requête.

​
Étapes

1

Ajouter un webhook

  1. Cliquez sur l’icône d’engrenage dans le menu de gauche pour ouvrir Settings, sélectionnez Webhooks, puis cliquez sur Add webhook.
    Page Webhooks avec l'icône d'engrenage Settings (1), l'entrée Webhooks (2) et le bouton Add webhook (3) en surbrillance

    Settings > Webhooks

  2. Remplissez le formulaire. Les numéros correspondent à la capture d’écran ci-dessous. 1. Saisissez l’Endpoint URL qui reçoit les notifications. Elle doit être accessible publiquement en HTTPS.
    2. Ajoutez au moins un Alert contact. Bodyguard prévient vos contacts lorsque les envois vers cet endpoint échouent. Chaque contact doit être un utilisateur enregistré dans votre organisation sur le dashboard.
    3. Choisissez les Sources auxquelles le webhook s’applique. Dans cet exemple, All the organization’s API sources est sélectionné.
    4. Sélectionnez les Events auxquels vous vous abonnez : message.updated (lorsqu’un message est mis à jour par Bodyguard) et author.updated (lorsqu’un auteur est mis à jour par Bodyguard).
    5. Cliquez sur Create webhook.
    Fenêtre New webhook avec les champs Endpoint URL (1), Alert contact (2), Sources (3) et Events (4), et le bouton Create webhook (5) en surbrillance

    Formulaire de création d'un webhook

    Consultez Configuration pour le détail de chaque champ et Payloads pour le contenu de chaque événement.
    Lorsque vous créez le webhook, Bodyguard envoie un événement webhook.validate à votre endpoint. Votre endpoint doit y répondre avec un code de statut 2xx.
2

Copier votre secret de signature

Bodyguard génère un secret de signature lorsque vous créez le webhook et l’affiche dans la fenêtre Webhook created. Copiez-le avec l’icône de copie et conservez-le en lieu sûr, puis cliquez sur Done. Le secret commence par whsec_.
Fenêtre Webhook created avec le champ du secret de signature et son icône de copie en surbrillance

Secret de signature affiché à la création

Le secret de signature n’est affiché qu’une seule fois. Vous ne pourrez plus le consulter après avoir fermé la fenêtre. Traitez-le comme un mot de passe et ne l’exposez jamais dans du code côté client.
Vous utilisez le secret de signature pour vérifier que chaque requête provient bien de Bodyguard. Consultez le Démarrage rapide.
3

Activer et tester votre webhook

Votre webhook est créé avec le statut Disabled. Activez-le lorsque votre endpoint est prêt à recevoir des événements. Cliquez sur le menu ⋮ à la fin de la ligne du webhook pour ouvrir ses actions :
Liste des webhooks avec le bouton trois points de la ligne du webhook (1) et son menu d'actions en surbrillance, affichant Send test event, Edit webhook, Enable webhook et Delete webhook

Menu d'actions du webhook

  • Enable webhook active le webhook.
  • Send test event vous permet de vérifier que votre endpoint reçoit des événements.
  • Edit webhook et Delete webhook vous permettent de modifier ou de supprimer le webhook.
Tant qu’un webhook est désactivé, Bodyguard n’envoie pas ses événements, et ils ne peuvent pas être rejoués lorsque vous réactivez le webhook. Consultez les statuts du webhook.

​
Étapes suivantes

Démarrage rapide

Créez un endpoint et vérifiez chaque requête avec une bibliothèque Standard Webhooks.

Configuration

Événements, secret de signature, contacts et statuts du webhook.

Gérer les erreurs

Ce qui se passe lorsque votre endpoint échoue, et comment rétablir la situation.