Les webhooks entrants vous permettent de recevoir des données en temps réel dans Brevo depuis une application externe. Chaque fois qu’un événement se produit dans votre application externe, Brevo reçoit un webhook contenant les détails de l’événement. Vous pouvez alors :
- déclencher un événement personnalisé dans Brevo, et/ou
- créer ou mettre à jour automatiquement un contact en fonction des données reçues.
Bon à savoir
- La fonctionnalité des webhooks entrants est actuellement en cours de déploiement progressif et peut ne pas être encore disponible sur tous les comptes.
- Vous pouvez créer jusqu’à 20 webhooks entrants dans votre compte Brevo. Pour ajouter un nouveau webhook au-delà de cette limite, supprimez-en un existant.
- Chaque URL de webhook peut gérer jusqu’à 20 événements par seconde.
- Pour l’instant, vous ne pouvez récupérer que les données du premier niveau hiérarchique du payload JSON.Cela signifie que vous pouvez accéder directement aux tableaux et aux objets de niveau supérieur, mais que vous ne pouvez pas récupérer de données à partir de tableaux imbriqués ou de niveaux plus détaillés.
- Si vous souhaitez créer des webhooks sortants pour envoyer des données en temps réel de Brevo vers une application externe, consultez notre article dédié Nouveaux webhooks : créer des webhooks sortants pour envoyer des données en temps réel de Brevo vers une application externe.
Étape 1 : créez un webhook entrant dans Brevo
Pour commencer, vous devez créer un webhook entrant dans Brevo.
- Dans Brevo, cliquez sur le menu déroulant du compte et sélectionnez Intégrations.
- Accédez à l'onglet Webhooks.
- Cliquez sur Ajouter un webhook.
- Sélectionnez Webhook entrant.
- Cliquez sur Ajouter un webhook.
Étape 2 : configurez le webhook entrant dans Brevo
Configurez à présent le webhook entrant dans Brevo.
- Entrez un nom pour le webhook.
- Cliquez sur Continuer.
- Sélectionnez la méthode HTTP que vous souhaitez utiliser pour ce webhook (POST, GET, PUT ou PATCH).
- Copiez l’URL du webhook générée par Brevo. Cette URL de rappel indique à votre application externe où envoyer le webhook entrant lorsqu’un événement se produit.
- Collez l’URL du webhook dans votre application externe. Cela se fait généralement depuis la page de configuration d'un webhook, une section d’automatisation ou via l'intégration d'une API.
💡 Bon à savoirSi vous ne savez pas où coller l’URL du webhook, consultez le centre d’aide de votre application externe ou contactez son équipe d’assistance. - (Facultatif) Pour ajouter un niveau de sécurité supplémentaire, ou si votre application externe l’exige :
- Activez l'option Exiger l'authentification.
- Copiez le token généré par Brevo.
💡 Bon à savoirSi votre jeton est compromis, vous pouvez le générer à nouveau en cliquant sur l'icône d'actualisation 🔄 et en le mettant à jour dans votre application externe. - Collez le jeton dans votre application externe.
- Terminez la configuration de votre webhook entrant dans votre application externe. Il vous sera peut-être demandé de sélectionner :
- l’événement qui déclenchera le webhook.
- les données à inclure dans la charge utile.
Étape 3 : envoyez une requête test et choisissez la charge utile à synchroniser
Assurez-vous que les paramètres que vous souhaitez synchroniser se trouvent dans les tableaux et les objets de niveau supérieur de la charge utile JSON, car les données imbriquées ou les niveaux plus détaillés ne sont pas accessibles pour le moment.
Testez le webhook entrant et confirmez les données d’événement reçues.
- Envoyez une requête test à Brevo depuis votre application externe.
- Vérifiez les données d'événement reçues pour vous assurer qu'elles contiennent tous les paramètres que vous souhaitez synchroniser. S’il manque des informations, envoyez des requêtes test supplémentaires jusqu’à ce que la charge utile correcte soit reçue.
- (Facultatif) Si plusieurs requêtes test ont été envoyées :
- Cliquez sur 🔄 Actualiser.
- Utilisez la liste déroulante pour sélectionner la charge utile souhaitée parmi les 10 dernières reçues.
- Cliquez sur Continuer.
Étape 4 : configurez l’action déclenchée par le webhook entrant
Configurez l’action qui doit être déclenchée dans Brevo lorsque le webhook est reçu. Cela implique de mapper les clés de charge utile (les données d’événement reçues dans le webhook entrant) aux attributs Brevo pour s’assurer que les données entrantes sont correctement formatées et déclenchent la bonne action.
Vous avez le choix entre deux actions disponibles :
-
Option 1 : créer un événement
Suivez les actions externes dans Brevo en créant un événement personnalisé. -
Option 2 : créer ou mettre à jour un contact
Ajoutez ou mettez à jour automatiquement les données du contact dans Brevo.
Vous pouvez déclencher un événement personnalisé dans Brevo lorsque le webhook entrant est déclenché dans votre application externe. Brevo lie l’événement à un contact spécifique en fonction de l’identifiant inclus dans le webhook (par exemple, adresse email, identifiant externe, etc.). Si aucun contact correspondant n’est trouvé, Brevo crée automatiquement un nouveau contact à l’aide de l’identifiant fourni.
- Cliquez sur + Ajouter une action.
- Sélectionnez Créer un événement.
-
Mappez les attributs d’événement Brevo à vos clés de charge utile à l’aide du sélecteur de variables {} ou entrez manuellement une valeur fixe qui sera appliquée chaque fois que le webhook est reçu. Il existe trois attributs d’événement Brevo obligatoires :
- event_name : nom de l'événement.
- identifiers : identifiants du contact utilisés pour lier l’événement au contact correspondant dans Brevo (par exemple, email, identifiant externe).
- event_date : date de l'événement.
- Marquez les attributs d’événement Brevo comme obligatoires ou facultatifs :
- Obligatoire : si l’attribut est manquant dans la charge utile, les actions du webhook ne seront pas mappées avec Brevo.
-
Facultatif : si l’attribut est manquant dans la charge utile, les actions du webhook seront toujours mappées avec Brevo, mais la valeur manquante sera définie sur "null".
- (Facultatif) Cliquez sur + Ajouter un attribut d’événement pour mapper des attributs d’événement Brevo supplémentaires.
- (Facultatif) Cliquez sur + Ajouter une action pour configurer une autre action déclenchée lors de la réception du webhook.
-
Cliquez sur Activez le webhook lorsque vous avez terminé.
-
Cliquez à nouveau sur Activer le webhook pour confirmer.
Vous pouvez ajouter ou mettre à jour automatiquement un contact dans Brevo lorsque le webhook est déclenché dans votre application externe. Brevo identifie et met à jour les contacts en fonction de l’identifiant inclus dans le webhook entrant (par exemple, adresse email, identifiant externe, etc.). Si aucun contact correspondant n’est trouvé, Brevo crée automatiquement un nouveau contact à l’aide de l’identifiant fourni.
- Cliquez sur + Ajouter une action.
- Sélectionnez Créer ou mettre à jour le contact.
-
Mappez les attributs du contact Brevo à vos clés de charge utile à l’aide du sélecteur de variables {} ou entrez manuellement une valeur fixe qui sera appliquée chaque fois que le webhook est reçu. Il existe un attribut du contact Brevo obligatoire :
- email : adresse email utilisée pour lier l’événement au contact correspondant dans Brevo.
- Marquez les attributs du contact Brevo comme obligatoires ou facultatifs :
- Obligatoire : si l’attribut est manquant dans la charge utile, les actions du webhook ne seront pas mappées avec Brevo.
-
Facultatif : si l’attribut est manquant dans la charge utile, les actions du webhook seront toujours mappées avec Brevo, mais la valeur manquante sera définie sur "null".
- (Facultatif) Cliquez sur + Ajouter un attribut du contact pour mapper des attributs du contact Brevo supplémentaires.
- (Facultatif) Cliquez sur + Ajouter une action pour configurer une autre action déclenchée lors de la réception du webhook.
-
Cliquez sur Activez le webhook lorsque vous avez terminé.
-
Cliquez à nouveau sur Activer le webhook pour confirmer.
Une fois activé, le webhook entrant envoie les données de votre application externe à Brevo chaque fois qu’il est déclenché. Vous pouvez ensuite utiliser les données reçues pour effectuer diverses actions, telles que les suivantes :
- Segmenter les contacts en fonction des données d’événement.
- Déclencher des automatisations à l'aide d'événements personnalisés.
- Personnaliser les emails, les SMS ou d’autres messages.
Consulter les logs d’un webhook entrant pour résoudre les problèmes
Chaque fois qu’un webhook entrant est déclenché, il envoie des données de votre application externe à Brevo, où les actions du webhook sont traitées. Vous pouvez consulter les logs d’un webhook entrant pour vérifier si les actions ont été correctement exécutées et identifier les problèmes potentiels pour les résoudre.
- Dans Brevo, cliquez sur le menu déroulant du compte et sélectionnez Intégrations.
- Accédez à l'onglet Webhooks.
- Sélectionnez l’option Webhook entrant. Vous trouverez ici un aperçu des actions traitées au cours des dernières 24 heures et leur statut pour chaque webhook entrant :
- Mappés : l'action a été correctement traitée.
-
Non mappés : une erreur s'est produite et l'action n'a pas été traitée.
- Cliquez sur le nom du webhook entrant pour accéder à ses logs.
- Dans l’onglet Logs, passez en revue les logs du webhook entrant :
- Filtrer par statut : affichez toutes les actions, uniquement les actions mappées ou les actions non mappées.
- Actualiser les logs : obtenez les dernières données en temps réel.
- Voir les appels de webhook entrant : vérifiez l’horodatage et la charge utile traitée pour chaque appel de webhook.
- Examiner les actions traitées et les attributs : voyez quelles actions Brevo a traitées après avoir reçu un webhook entrant et vérifiez les données transmises pour chaque action. En cas d'erreur, comparez le type de clé attendu à la valeur reçue.
Désactiver un webhook entrant
Si vous devez cesser temporairement de recevoir des données de votre application externe, vous pouvez désactiver le webhook entrant.
- Dans Brevo, cliquez sur le menu déroulant du compte et sélectionnez Intégrations.
- Accédez à l'onglet Webhooks.
- Sélectionnez l’option Webhook entrant.
- Désactivez le webhook entrant de votre choix.
Le webhook entrant 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 entrant
Si vous n’avez plus besoin d’un webhook entrant, vous pouvez le supprimer définitivement.
- Dans Brevo, cliquez sur le menu déroulant du compte et sélectionnez Intégrations.
- Accédez à l'onglet Webhooks.
- Sélectionnez l’option Webhook entrant.
- À côté du webhook entrant que vous souhaitez supprimer, cliquez sur l’icône de la corbeille.
- Cliquez sur Supprimer le webhook pour confirmer.
Le webhook entrant et son URL de rappel associée ont été définitivement supprimés.
⏭️ Et après ?
- Nouveaux webhooks : créer des webhooks sortants pour envoyer des données en temps réel de Brevo vers une application externe
- Envoyer des webhooks sortants depuis une automatisation
🤔 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.