Webhooks
Les webhooks sont un moyen courant pour les applications de communiquer entre elles et de partager des données en temps réel. Aujourd’hui, il est rare qu’une seule application autonome puisse tout faire. La plupart du temps, vous travaillez avec de nombreuses applications ou systèmes spécialisés dans certaines tâches, et ces applications doivent pouvoir communiquer entre elles. C’est là que les webhooks entrent en jeu.
Un webhook est un message automatisé envoyé d’un système à un autre lorsque certains critères sont remplis. Dans Braze, ce critère est généralement le déclenchement d’un événement personnalisé.
Fondamentalement, un webhook est une méthode événementielle permettant à deux systèmes distincts d’agir efficacement sur la base de données transmises en temps réel. Ce message contient des instructions indiquant au système destinataire quand et comment effectuer une tâche donnée. Grâce à cela, les webhooks vous offrent un accès plus dynamique et flexible aux données et aux fonctionnalités programmatiques, tout en vous permettant de mettre en place des parcours clients qui simplifient vos processus.
La disponibilité des webhooks dépend de votre offre Braze. Contactez votre Account Manager ou votre Customer Success Manager pour commencer.
Section Articles
Cas d’utilisation
Les webhooks sont un excellent moyen de connecter vos systèmes entre eux. Après tout, c’est comme ça que les applications communiquent. Voici quelques scénarios courants dans lesquels les webhooks peuvent s’avérer particulièrement utiles :
- Envoyer des données vers et depuis Braze
- Envoyer des messages à vos clients via des canaux qui ne sont pas directement pris en charge par Braze
- Publier vers les API de Braze
Voici quelques cas d’utilisation plus spécifiques :
- Si un utilisateur se désabonne de vos e-mails, un webhook peut mettre à jour votre base de données analytique ou votre CRM avec cette même information, vous offrant ainsi une vision globale du comportement de cet utilisateur.
- Envoyez des messages transactionnels aux utilisateurs via Facebook Messenger ou Line.
- Envoyez du publipostage aux clients en réponse à leur activité in-app et web en utilisant des webhooks pour communiquer avec des services tiers comme Lob.com.
- Si un joueur atteint un certain niveau ou accumule un certain nombre de points, utilisez les webhooks et votre configuration API existante pour envoyer une amélioration de personnage ou des pièces directement sur son compte. Si vous envoyez le webhook dans le cadre d’une campagne de communication multicanale, vous pouvez également envoyer une notification push ou un autre message pour informer le joueur de sa récompense en même temps.
- Si vous êtes une compagnie aérienne, vous pouvez utiliser les webhooks et votre configuration API existante pour créditer le compte d’un client d’une réduction après qu’il a réservé un certain nombre de vols.
- Des recettes « If This Then That » (IFTTT) à l’infini : par exemple, si un client se connecte à l’application par e-mail, cette adresse peut être automatiquement configurée dans Salesforce.
Anatomie d’un webhook
Un webhook se compose des éléments suivants.
| Élément du webhook | Description |
|---|---|
| Méthode HTTP | Comme pour les API, les webhooks ont besoin de méthodes de requête. Elles sont transmises à l’URL ciblée par le webhook et indiquent à l’endpoint quoi faire avec les informations reçues. Vous pouvez spécifier quatre méthodes HTTP : POST, GET, PUT et DELETE. |
| URL HTTP | L’adresse URL de votre endpoint webhook. L’endpoint est l’endroit où vous enverrez les informations capturées par le webhook. |
| Corps de la requête | Cette partie du webhook contient les informations que vous transmettez à l’endpoint. Le corps de la requête peut contenir des paires clé-valeur JSON ou du texte brut. |
Méthodes HTTP
Le tableau suivant décrit les quatre méthodes HTTP que vous pouvez spécifier dans votre webhook.
| Méthode HTTP | Description |
|---|---|
| POST | Cette méthode écrit de nouvelles informations sur le serveur destinataire. Un exemple courant de la méthode POST est un formulaire de contact sur un site web. Les informations que vous saisissez dans le formulaire font partie du corps de la requête et sont envoyées à un récepteur. C’est la méthode la plus utilisée pour envoyer des données. |
| GET | Cette méthode récupère des informations existantes, contrairement à l’écriture de nouvelles informations. Par définition, une requête GET ne comporte pas de corps de requête. C’est la méthode la plus courante pour demander des données à un serveur. Prenons l’exemple de l’endpoint /segments/list. Si vous effectuez une requête GET, elle renvoie la liste de vos segments. |
| PUT | Cette méthode met à jour les informations sur l’endpoint en remplaçant les informations existantes par le contenu du corps de la requête. |
| DELETE | Cette méthode supprime la ressource à l’URL HTTP indiquée. |
Les webhooks dans Braze
Dans Braze, vous pouvez créer un webhook en tant que campagne webhook, campagne API ou composant Canvas.
- Dans le tableau de bord de Braze, accédez à Campagnes.
- Cliquez sur Créer une campagne et sélectionnez Webhook.
Pour plus d’informations, consultez Créer un webhook.
- Dans le tableau de bord de Braze, accédez à Campagnes.
- Cliquez sur Créer une campagne et sélectionnez Campagne API.
- Cliquez sur Ajouter des messages et sélectionnez Webhook.
- Formulez votre appel API de manière à inclure un objet webhook.
Pour plus d’informations, consultez Créer un webhook.
- Créez un nouveau composant dans votre Canvas.
- Dans la section Message de votre composant, sélectionnez Webhook.
Pour plus d’informations, consultez Créer un webhook.
Gestion des erreurs et limite de débit des webhooks
Lorsque Braze reçoit une réponse d’erreur suite à un appel webhook, le comportement d’envoi de ce webhook est automatiquement ajusté en fonction des en-têtes de réponse suivants :
Retry-AfterX-Rate-Limit-LimitX-Rate-Limit-RemainingX-Rate-Limit-Reset
Ces en-têtes nous permettent d’interpréter les limites de débit et d’adapter la vitesse d’envoi en conséquence pour éviter d’autres erreurs. Nous appliquons également une stratégie de délais exponentiels pour les nouvelles tentatives, ce qui réduit le risque de saturation de vos serveurs en espaçant les tentatives dans le temps.
Si nous constatons que la majorité des demandes de webhook adressées à un hôte spécifique échouent, toutes les tentatives d’envoi vers cet hôte sont temporairement suspendues. L’envoi reprend après une période de pause définie, laissant le temps à votre système de se rétablir.