guides / Webhook
Florian avatar



What are webhooks ?

Webhooks are one way that apps can send notifications or information to other apps. Usually, these notifications take the form of HTTP requests triggered by a specific event and sent to your application.

Without webhooks (polling)

Getting informations from an API without Webhooks:

  • Must loop every X time

  • Quota issues

  • No real time Notification

With webhooks

Getting informations with webhooks:

  • Ease of integration

  • No quota issues

  • Real time Notification

Bodyguard’s Webhooks

Along with the analysis API, we offer Webhooks capabilities. These Webhooks allow you to be notified in real time about the status change of some Bodyguard’s resources. They are basic HTTPS POST requests.

When to use webhooks

Webhooks will allow you to automate actions on your application following some Bodyguard’s events. We strongly recommend to integrate Bodyguard’s webhooks in order to stay up-to-date with the state of each resource.

Indeed, some analyses are performed asynchronously and some actions can be taken manually from our Dashboard.

So we may update the analysis response later on (eg: A member of your community which has become too hateful, can be banned at any time using our automatic detection feature or via a manual action on the dashboard).

How it works

Webhook integration is done in 2 steps:

  1. Create a Webhook (see our example here) dedicated endpoint on your server

  2. Configure and register this endpoint on your Dashboard

Bodyguard will send HTTPS POST requests to your endpoint when any event you have subscribed to is triggered.