Création d’un webhook Braze à Braze

Vous pouvez utiliser des webhooks pour communiquer avec l’API REST de Braze, essentiellement pour faire tout ce que notre API vous permet de faire. C’est ce que nous appelons un webhook Braze à Braze, un webhook qui communique depuis Braze vers Braze. Les cas d’utilisation présentés sur cette page supposent que vous connaissez le fonctionnement des webhooks et comment créer un webhook à Braze.

Conditions préalables

Pour créer un webhook Braze à Braze, vous aurez besoin d’une clé API avec des autorisations pour l’endpoint que vous souhaitez atteindre.

Configuration de votre webhook Braze à Braze

Bien que les spécificités de votre demande de webhook varient d’un cas d’utilisation à l’autre, le flux de travail général pour créer un webhook Braze à Braze reste le même.

1. Créez un webhook en tant que composant de campagne ou de canvas.
2. Sélectionnez Modèle vierge.
3. Dans l’onglet Composer, spécifiez l’URL du webhook et le corps de la requête comme indiqué pour votre cas d’utilisation.
4. Dans l’onglet Paramètres, spécifiez la méthode HTTP et les en-têtes de requête comme indiqué pour votre cas d’utilisation.
5. Continuez à créer le reste de votre webhook au besoin. Certains cas d’utilisation nécessitent des paramètres de distribution particuliers, tels que le déclenchement de la campagne ou du canvas à partir d’un événement personnalisé.

Cas d’utilisation

Les webhooks de Braze à Braze permettent de réaliser de nombreuses choses, mais voici quelques cas d’utilisation pour vous aider à démarrer :

• Incrémentez un attribut personnalisé sous forme d’entier pour créer un compteur lorsqu’un utilisateur reçoit un message.
• Déclencher un deuxième Canvas depuis un premier Canvas.

Cas d’utilisation : Incrémentez un attribut personnalisé sous forme d’entier pour obtenir un compteur

Ce cas d’utilisation implique de créer un attribut personnalisé et d’utiliser Liquid pour décompter le nombre de fois où une action donnée a eu lieu.

Par exemple, vous pourriez vouloir compter combien de fois un utilisateur a vu une campagne de messages in-app active et l’empêcher de recevoir à nouveau la campagne après l’avoir vue trois fois. Pour plus d’idées sur ce que vous pouvez faire avec la logique Liquid dans Braze, consultez notre bibliothèque de cas d’utilisation Liquid.

Suivez les étapes générales de création d’un webhook Braze à Braze, et reportez-vous à ce qui suit lors de la configuration de votre webhook :

• URL du webhook : Votre URL de l’endpoint REST suivi de /users/track. Par exemple, pour l’instance US-06, l’URL serait https://rest.iad-06.braze.com/users/track.
• Corps de la requête : Texte brut

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

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

• En-tête de la requête :
  • Autorisation : Porteur {YOUR_API_KEY}
  • Content-Type : application/json
• Méthode HTTP : POST

Remplacez YOUR_API_KEY par une clé API REST Braze avec des autorisations users.track. Vous pouvez créer une clé API dans le tableau de bord de Braze sous Paramètres > Clés API.

Corps de la demande

Ajoutez votre requête de suivi des utilisateurs dans le corps de la requête et le Liquid pour assigner une variable de décompte. Pour plus de détails, reportez-vous au /users/track endpoint.

Vous trouverez ci-après un exemple du Liquid et du corps de requête nécessaire pour cet endpoint, dans lequel your_attribute_count est l’attribut que vous utilisez pour décompter le nombre de fois où un utilisateur a vu le message :

1
2
3
4
5
6
7
8
9
{% assign new_number = {{custom_attribute.${your_attribute_count}}} | plus: 1 %}
{
    "attributes": [
        {
        "external_id": "{{${user_id}}}",
        "your_attribute_count": "{{new_number}}"
        }
    ]
}

Cas d’utilisation : Déclencher un deuxième Canvas depuis un premier Canvas

Pour ce cas d’utilisation, vous allez créer deux Canvas et utiliser un webhook pour déclencher le second Canvas depuis le premier. Ceci agit comme un déclencheur d’entrée pour le moment auquel un utilisateur atteint un certain point dans un autre Canvas.

1. Commencez par créer votre deuxième Canvas, celui qui doit être déclenché par le Canvas d’origine.
2. Pour la planification d’entrée du canvas, sélectionnez Déclenché par l’API.
3. Prenez note de votre ID de canvas. Vous en aurez besoin dans une étape ultérieure.
4. Continuez à créer les étapes de votre deuxième Canvas, puis enregistrez-le.
5. Ensuite, créez votre premier Canvas. Trouvez l’étape à laquelle vous désirez déclencher le deuxième Canvas et créez une nouvelle étape avec un webhook.

Référez-vous aux informations ci-dessous lorsque vous configurez votre webhook :

• URL du webhook : Votre URL de l’endpoint REST suivi 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 : Texte brut

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

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

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

Remplacez YOUR_API_KEY par une clé API REST Braze avec des autorisations canvas.trigger.send. Vous pouvez créer une clé API dans le tableau de bord de Braze sous Paramètres > Clés API.

Corps de la demande

Ajoutez votre requête canvas/trigger/send dans le champ de texte. Pour plus de détails, consultez la section Envoyer des messages Canvas à l’aide d’une livraison déclenchée par API. Vous trouverez ci-après un exemple du corps de la requête pour cet endpoint, dans lequel your_canvas_id est l’ID Canvas de votre deuxième Canvas :

1
2
3
4
5
6
7
8
{
      "canvas_id": "your_canvas_id",
      "recipients": [
        {
          "external_user_id": "{{${user_id}}}"
         }
      ]
}

Choses à savoir

• Les webhooks Braze à Braze sont soumis aux limites de débit des endpoints.
• Les mises à jour du profil utilisateur entraîneront des points de données supplémentaires, alors que le déclenchement d’un autre message par le biais des points d’extrémité de messages n’en entraînera pas.
• Si vous souhaitez cibler des utilisateurs anonymes, vous pouvez utiliser braze_id au lieu de external_id dans le corps de la requête de votre webhook.
• Vous pouvez enregistrer votre webhook Braze à Braze comme modèle à réutiliser.
• Vous pouvez consulter le journal d’activité des messages pour visualiser et résoudre les problèmes liés aux webhooks.