> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bodyguard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction aux webhooks

> Recevez des notifications en temps réel lorsque l'état d'un message ou d'un auteur change dans Bodyguard.

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](https://docs.bodyguard.ai/fr/api-reference/reference/webhooks/payloads.md#structure-du-payload), 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](https://www.standardwebhooks.com). Vous les vérifiez avec une bibliothèque open source, sans écrire de code spécifique à Bodyguard.

> [!WARNING]
>
> 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](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.

| | Polling | Webhooks |
| - | - | - |
| Récupération des événements | Vous appelez une API en boucle, à intervalle fixe | Bodyguard appelle votre endpoint lorsqu'un événement se produit |
| Notification en temps réel | Non | Oui |
| Impact sur les quotas | Chaque appel compte dans vos quotas | Aucun |
| Effort d'intégration | Un ordonnanceur et un suivi d'état | Un endpoint HTTPS |

## 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](https://docs.bodyguard.ai/fr/api-reference/webhooks/quick-start.md) 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](https://docs.bodyguard.ai/fr/api-reference/webhooks/configuration.md) pour le détail de chaque champ. Lorsque vous enregistrez, Bodyguard envoie un événement [`webhook.validate`](https://docs.bodyguard.ai/fr/api-reference/reference/webhooks/payloads#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`](https://docs.bodyguard.ai/fr/api-reference/reference/webhooks/payloads#webhook-validate) et vérifier que votre endpoint reçoit bien les événements.

Une fois activé, votre webhook a le [statut](https://docs.bodyguard.ai/fr/api-reference/webhooks/configuration.md#statuts-du-webhook) `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](https://docs.bodyguard.ai/fr/api-reference/reference/webhooks/payloads.md) pour le contenu de chaque requête.

## Étapes suivantes

> [card] [Démarrage rapide](https://docs.bodyguard.ai/fr/api-reference/webhooks/quick-start.md)
>
> Créez un endpoint et vérifiez chaque requête avec une bibliothèque Standard Webhooks.

> [card] [Configuration](https://docs.bodyguard.ai/fr/api-reference/webhooks/configuration.md)
>
> Événements, secret de signature, contacts et statuts du webhook.

> [card] [Payloads](https://docs.bodyguard.ai/fr/api-reference/reference/webhooks/payloads.md)
>
> En-têtes, structure du payload et un exemple pour chaque type d'événement.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.