Skip to content

Créer un webhook Braze-à-Braze

Les webhooks Braze-à-Braze vous permettent d’appeler la REST API de Braze depuis Braze en utilisant un webhook dans une Campaign ou un Canvas. Utilisez-les pour des tâches d’orchestration comme le déclenchement d’un Canvas déclenché par API. Pour mettre à jour les attributs utilisateur, les événements personnalisés ou les achats depuis un Canvas, utilisez plutôt la Mise à jour utilisateur. Elle est conçue pour les modifications de profil utilisateur et traite les mises à jour de manière plus efficace.

Pour tirer le meilleur parti de cet article, vous devez être familier avec le fonctionnement des webhooks et savoir comment créer un webhook dans Braze.

Utiliser la Mise à jour utilisateur pour les modifications de données utilisateur

Pour mettre à jour les profils utilisateur depuis un Canvas, y compris la modification des attributs personnalisés, l’enregistrement d’événements personnalisés ou l’enregistrement d’achats, utilisez la Mise à jour utilisateur plutôt qu’un webhook Braze-à-Braze.

La Mise à jour utilisateur regroupe plusieurs modifications et les envoie par lots, ce qui est plus rapide que les webhooks. Elle est plus facile à configurer qu’un webhook et prend en charge les mises à jour complexes grâce à son compositeur JSON avancé. Par exemple, pour compter le nombre de fois qu’un utilisateur a vu un message, utilisez la fonctionnalité Incrémenter et décrémenter de la Mise à jour utilisateur plutôt qu’un webhook Braze-à-Braze.

Quand utiliser un webhook Braze-à-Braze

La Mise à jour utilisateur peut gérer presque toutes les mêmes tâches qu’un webhook Braze-à-Braze pour la mise à jour des profils utilisateur. Pour les mises à jour complexes allant au-delà des simples attributs personnalisés, vous pouvez utiliser le compositeur JSON avancé.

Vous pouvez utiliser un webhook Braze-à-Braze lorsque vous devez appeler la REST API de Braze depuis Braze pour des scénarios autres que les mises à jour directes d’utilisateurs depuis des étapes du canvas. Les exemples courants incluent :

Pour les mises à jour d’utilisateurs dans un Canvas, la méthode recommandée est d’utiliser la Mise à jour utilisateur.

Conditions préalables

Pour créer un webhook Braze-à-Braze, vous avez besoin d’une clé API avec les autorisations pour l’endpoint que vous souhaitez atteindre. Par exemple, pour déclencher un Canvas déclenché par API, vous avez besoin d’une clé API avec l’autorisation canvas.trigger.send.

Configurer votre webhook Braze-à-Braze

Le flux de travail général pour créer un webhook Braze-à-Braze suit ces étapes :

  1. Créez un webhook en tant que Campaign ou composant Canvas.
  2. Choisissez Blank Template.
  3. Dans l’onglet Rédiger, spécifiez l’URL du webhook et le corps de la requête pour votre cas d’utilisation API.
  4. Dans l’onglet Paramètres, spécifiez votre méthode HTTP et les en-têtes de requête requis par l’endpoint.
  5. Configurez les paramètres de distribution supplémentaires (par exemple, le déclenchement à partir d’un événement personnalisé) et finalisez le reste de votre Campaign ou Canvas.

Déclencher un second Canvas depuis un Canvas initial

Dans ce cas d’utilisation, vous créez deux Canvas et utilisez un webhook Braze-à-Braze pour déclencher le second Canvas depuis le premier. Cela agit comme un déclencheur d’entrée lorsqu’un utilisateur atteint un certain point dans un autre Canvas.

  1. Commencez par créer votre second Canvas — le Canvas qui doit être déclenché par votre Canvas initial.
  2. Pour la planification d’entrée du Canvas, sélectionnez API-Triggered.
  3. Notez votre Canvas ID. Vous en aurez besoin dans une étape ultérieure.
  4. Continuez à construire les étapes de votre second Canvas, puis enregistrez le Canvas.
  5. Enfin, créez votre premier Canvas. Trouvez l’étape où vous souhaitez déclencher le second Canvas et créez une nouvelle étape avec un webhook.

Consultez les informations suivantes lors de la configuration de votre webhook :

  • URL du webhook : Votre URL d’endpoint REST suivie de /canvas/trigger/send. Par exemple, pour l’instance US-06, l’URL serait https://rest.iad-06.braze.com/canvas/trigger/send.
  • Corps de la requête : Raw Text

En-têtes de requête et méthode

Braze nécessite un en-tête HTTP pour l’autorisation qui inclut votre clé API et un autre qui déclare votre type de contenu.

  • En-têtes de requête :
    • Authorization : Bearer YOUR_API_KEY
    • Content-Type : application/json
  • Méthode HTTP : POST

Remplacez YOUR_API_KEY par une clé API Braze disposant des autorisations canvas.trigger.send. Vous pouvez créer une clé API dans le tableau de bord de Braze en accédant à Paramètres > Clés API.

En-têtes de requête pour le webhook montrant les champs Authorization et Content-Type dans le tableau de bord de Braze.

Corps de la requête

Ajoutez votre requête /canvas/trigger/send dans le champ de texte. Pour plus de détails, consultez Envoyer des messages Canvas via une distribution déclenchée par API. Voici un exemple de corps de requête pour cet endpoint, où your_canvas_id est le Canvas ID de votre second Canvas :

1
2
3
4
5
6
7
8

{
  "canvas_id": "your_canvas_id",
  "recipients": [
    {
      "external_user_id": "{{${user_id}}}"
    }
  ]
}

Lorsqu’un utilisateur atteint cette étape webhook dans le premier Canvas, Braze déclenche le second Canvas pour cet utilisateur via l’API.

Considérations

  • Mises à jour utilisateur : Pour mettre à jour les profils utilisateur depuis un Canvas (attributs, événements, achats), utilisez la Mise à jour utilisateur plutôt que les webhooks Braze-à-Braze pour une meilleure efficacité et un meilleur rapport coût-efficacité.
  • Les webhooks Braze-à-Braze sont soumis aux limites de débit des endpoints.
  • Les mises à jour du profil utilisateur entraînent des points de donnée qui comptent dans votre consommation globale, tandis que le déclenchement d’un autre message via les endpoints d’envoi de messages n’en génère pas.
  • Pour cibler les utilisateurs anonymes, utilisez braze_id au lieu de external_id dans le corps de la requête de votre webhook.
  • Vous pouvez enregistrer votre webhook Braze-à-Braze en tant que modèle de webhook pour le réutiliser.
  • Vous pouvez consulter le Journal d’activité des messages pour visualiser et résoudre les échecs de webhook.
New Stuff!