Passer au contenu principal
Un webhook notifie un système d’un changement d’état dans un autre système. Concrètement, il s’agit d’une requête HTTP avec un payload JSON, envoyée par le système central vers un endpoint que vous contrôlez. Les webhooks Bodyguard envoient des notifications en temps réel lorsqu’une ressource change. Ce sont des requêtes POST en HTTPS, et elles suivent la spécification Standard Webhooks. Vous les vérifiez avec une bibliothèque open source, sans écrire de code spécifique à Bodyguard.
Cette section décrit les webhooks de la nouvelle API Bodyguard. La documentation des webhooks existants est disponible sur https://www.bodyguard.ai/docs/api/webhooks/introduction.

​
Webhooks vs. polling

Le polling et les webhooks sont deux façons générales d’être informé des changements dans un autre système. Cette comparaison n’explique que les concepts : Bodyguard envoie les changements par webhooks et ne fournit pas d’API de polling.

​
Quand utiliser les webhooks

Les webhooks vous permettent d’automatiser des actions dans votre application en fonction des événements Bodyguard. Nous recommandons de les intégrer pour suivre l’état de chaque ressource. Cas d’usage typiques :
  • Décisions sur les messages : vous recevez une notification lorsqu’un message est classifié SPAM, ou lorsque son action recommandée change.
  • Décisions automatiques sur les auteurs : vous recevez une notification lorsqu’un auteur est banni ou muté en fonction de son comportement (par exemple un bot ou un escroc).
  • Actions manuelles depuis le dashboard : vous recevez une notification lorsqu’un message est supprimé (son action recommandée passe à REMOVE) ou qu’un auteur est banni depuis le dashboard Bodyguard.

​
Fonctionnement

1

Créez votre endpoint

Développez sur votre serveur un endpoint qui accepte les requêtes POST sur une URL HTTPS publique, et qui vérifie la signature de chaque requête. Consultez Démarrage rapide pour des exemples prêts à l’emploi.
2

Enregistrez-le dans le dashboard

Cliquez sur l’icône d’engrenage dans le menu de gauche pour ouvrir Settings, sélectionnez Webhooks, puis cliquez sur Add webhook +. Remplissez le formulaire : consultez Configuration pour le détail de chaque champ. Lorsque vous enregistrez, Bodyguard envoie un événement webhook.validate à votre endpoint, qui doit répondre avec un code de statut 2xx pour que l’enregistrement réussisse.
3

Testez l'intégration

Cliquez sur Send test event à tout moment pour envoyer un événement webhook.validate et vérifier que votre endpoint reçoit bien les événements.
Une fois activé, votre webhook a le statut ENABLED et Bodyguard envoie une requête HTTPS POST à votre endpoint chaque fois qu’un événement auquel vous êtes abonné est déclenché. Consultez Payloads pour le contenu de chaque requête.

​
É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.

Payloads

En-têtes, structure du payload et un exemple pour chaque type d’événement.