Créer des webhooks sortants pour envoyer des données en temps réel de Brevo vers une application externe

Cet article décrit la nouvelle expérience de gestion des webhooks, qui propose plus d’événements et des fonctionnalités améliorées. Tous vos webhooks sortants existants ont été migrés automatiquement, afin que vous puissiez commencer à utiliser la nouvelle expérience immédiatement sans rien recréer ni reconfigurer.

Les webhooks sortants vous permettent d’envoyer des données en temps réel de Brevo vers une application externe. Lorsqu’un événement spécifique se produit dans Brevo, votre application externe reçoit une notification contenant les détails de l’événement.

Vous pouvez créer des webhooks sortants pour les événements liés aux fonctionnalités Brevo suivantes :

  • Email marketing
  • SMS marketing
  • Email transactionnel
  • SMS transactionnel
  • Contacts
  • Opportunités
  • Cohort
  • Conversations
  • WhatsApp
  • Meetings
  • Bon de réduction
  • Fidélité
  • Push
  • Phone
  • Site web
  • Push web
  • Paiement
  • Formulaires
  • E-commerce

Bon à savoir

Avant de commencer

Depuis votre application externe, veillez à récupérer les éléments suivants :

  • L'URL du serveur ou du point de terminaison auquel vous souhaitez envoyer le webhook sortant
  • (Facultatif) La méthode d'authentification et les informations d'identification requises
  • Tout nom et valeur d’en-tête requis

Si vous ne savez pas où récupérer ces informations, consultez le centre d’aide de votre application externe ou contactez son équipe d’assistance.

Étape 1 : créez un webhook sortant dans Brevo

Pour créer un webhook sortant dans Brevo :

  1. Dans Brevo, cliquez sur le nom de votre compte et sélectionnez Intégrations > Webhooks.
  2. Cliquez sur Ajouter un webhook.
    webhook_outbound_create_en-us.png
  3. Sélectionnez Webhook sortant.
  4. Cliquez sur Ajouter un webhook.
    webhook_outbound_add_en-us.png

Étape 2 : configurez le webhook sortant

❗️ Important
Assurez-vous d'avoir récupéré les informations nécessaires depuis votre application externe, comme expliqué dans notre section Avant de commencer.

Ensuite, configurez le nom, l’URL et la méthode d’authentification du webhook sortant.

  1. Saisissez un nom pour le webhook.
  2. Cliquez sur Continuer.
  3. Saisissez l’URL du serveur ou du point de terminaison auquel vous souhaitez envoyer vos événements. Cela indique à Brevo où envoyer le webhook sortant lorsqu’un événement se produit.
    webhook_outbound_setup_en-us.png
  4. (Facultatif) Par défaut, Pas d'authentification est sélectionnée comme méthode d'authentification. Pour ajouter un niveau de sécurité supplémentaire, ou si l’application externe à laquelle vous envoyez le webhook l’exige, vous pouvez choisir :
    • authentification de base (nom d'utilisateur et mot de passe), ou
    • authentification par jeton
      webhook_outbound_authentication_en-us.png
  5. (Facultatif) Pour ajouter un en-tête à votre webhook sortant :
    1. Cliquez sur + Ajouter un objet.
    2. Saisissez le nom et la valeur de l'en-tête.
      webhook_outbound_header_en-us.png
  6. Sélectionnez votre stratégie d’envoi de webhook :
    • Envoyer un à la fois
      Envoyer des événements individuellement en temps réel.
    • Envoyer par lots
      Envoyer des événements par lots de 500 maximum. Cette option est recommandée si vous avez des limites de débit plus faibles, car cela peut réduire le nombre de requêtes.
  7. Cliquez sur Continuer.

Étape 3 : choisissez les événements et envoyez les requêtes test

Enfin, choisissez les événements pour lesquels vous souhaitez recevoir le webhook sortant et envoyez des requêtes test à votre application externe.

  1. Sélectionnez la catégorie d’événement pour laquelle vous souhaitez créer un webhook sortant (par exemple, Email transactionnel, Opportunités, Formulaires, etc.).
    💡 Bon à savoir
    Les événements des contacts se trouvent dans la catégorie d'événement Emails marketing.
  2. Par défaut, tous les événements de la catégorie sélectionnée sont activés. Si nécessaire, vous pouvez désactiver des événements spécifiques en désactivant leur bouton bascule.
    webhook_outbound_events_en-us.png
  3. (Facultatif) Pour envoyer des requêtes test pour les événements :
    1. Cliquez sur l’icône des trois points à côté d’un événement et sélectionnez Envoyer une requête test.
      webhook_outbound_test-request_en-us.png
    2. Vérifiez votre application externe pour confirmer que vous avez reçu le webhook sortant.
  4. Cliquez sur Activer le webhook lorsque vous avez terminé.

Sécuriser vos webhooks sortants

Pour sécuriser vos webhooks sortants, vous devez ajouter à la liste d'autorisation certaines des plages IP de Brevo. Cela permet de s’assurer que seules les requêtes autorisées peuvent déclencher les webhooks

➡️ Pour en savoir plus, consultez notre article dédié Plages IP de Brevo : liste des services exposés publiquement.

💡 Bon à savoir
Ces plages IP concernent les webhooks marketing, les webhooks transactionnels et les webhooks appelés directement à partir d'une automatisation.

Surveiller la livraison des webhooks et configurer des alertes

💡 Bon à savoir
Cette fonctionnalité est actuellement en version bêta.

Surveillez la livraison des événements de webhook sortant et configurez des alertes pour être informé lorsque des problèmes surviennent.

Consulter vos statistiques de webhook

Le tableau de bord de surveillance vous aide à suivre le statut de livraison de vos événements de webhook sortant. Cela vous permet d'identifier rapidement les problèmes de délivrabilité.

Pour consulter les statistiques des événements de webhook sortant :

  1. Dans Brevo, cliquez sur le nom de votre compte et sélectionnez Intégrations > Webhooks.
  2. Depuis l’onglet Webhooks sortants, cliquez sur le webhook sortant que vous souhaitez surveiller.
  3. Sous Statistiques, consultez l'état de délivrabilité de vos événements de webhook sortant :

    📨 États de livraison📊 Graphique à barres
    int_outbound-webhooks_delivery-states_en-us.png

    Consultez le nombre d’événements de webhook sortant au cours des dernières 24 heures dans trois états de livraison :

    • ❌ Échec : nombre d’événements de webhook sortant uniques qui n’ont pas pu être délivrés après 24 heures de nouvelles tentatives et ont été supprimés.
    • ⚠️ Nouvelles tentatives : nombre d’événements de webhook sortant uniques actuellement en cours de nouvelle tentative au cours des dernières 24 heures. Pour en savoir plus sur le mécanisme de nouvelle tentative, consultez notre documentation API dédiée.
    • ✅ Délivré : nombre d’événements de webhook sortant uniques correctement délivrés au cours des dernières 24 heures.
❗️ Important
La rediffusion de l’événement n’est pas encore disponible pour les événements de webhook sortant ayant échoué. Si un événement de webhook sortant échoue, vous pouvez récupérer les logs depuis la page Logs d'événements. Avec une offre Enterprise, vous pouvez également exporter l’historique de vos événements de webhook via l’API. Pour en savoir plus, consultez notre documentation API dédiée.

Configurer des alertes webhook

Configurez des alertes par email pour être informé lorsque des problèmes de livraison des événements de webhook sortant atteignent un seuil défini. Les alertes sont envoyées à l’adresse email par défaut de votre compte, avec un maximum d'une notification par heure lorsqu’un seuil est atteint.

Pour configurer les alertes de webhook :

  1. Dans Configuration des alertes, activez les alertes que vous souhaitez recevoir :
    • Alerte de nouvelle tentative
      Définissez un seuil pour recevoir une notification lorsque le nombre de nouvelles tentatives d’événements de webhook sortant atteint cette valeur. Le seuil minimum est de 50.
    • Alerte d’échec
      Définissez un seuil pour recevoir une notification lorsque le nombre d’événements de webhook sortant ayant échoué atteint cette valeur. Le seuil minimum est de 50.
      int_outbound-webhooks_alerts_en-us.png
  2. Cliquez sur Enregistrer.

Désactiver un webhook sortant

Si vous devez cesser temporairement de recevoir des données de Brevo dans votre application externe, vous pouvez désactiver le webhook sortant.

  1. Dans Brevo, cliquez sur le menu déroulant du compte et sélectionnez Intégrations.
  2. Accédez à l'onglet Webhooks.
  3. Sélectionnez l’option Webhook sortant.
  4. Désactivez le webhook sortant de votre choix.
     int_outbound-webhooks_deactivate_en-us.png

Le webhook sortant est maintenant désactivé (le bouton bascule est gris). Vous pouvez le réactiver à tout moment en appuyant à nouveau sur le bouton bascule.

Supprimer un webhook sortant

❗️ Important
Cette action est irréversible. Une fois supprimé, le webhook sortant ne peut pas être restauré.

Si vous n’avez plus besoin d’un webhook sortant, vous pouvez le supprimer définitivement.

  1. Dans Brevo, cliquez sur le nom de votre compte et sélectionnez Intégrations.
  2. Accédez à l'onglet Webhooks.
  3. Sélectionnez l’option Webhook sortant.
  4. À côté du webhook sortant que vous souhaitez supprimer, cliquez sur l’icône de la corbeille 🗑️.
    webhook_outbound_delete_en-us.png
  5. Cliquez sur Supprimer le webhook pour confirmer.

Le webhook sortant est définitivement supprimé.

🤔 Vous avez des questions ?

Pour toute question, n’hésitez pas à contacter notre service client en créant un ticket à partir de votre compte. Si vous n’avez pas encore de compte, vous pouvez nous contacter ici.

Si vous avez besoin d'aide pour un projet impliquant Brevo, nous pouvons vous mettre en relation avec une agence partenaire Brevo.

💬 Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 12 sur 23