Créer une campagne webhook

La création d’une campagne webhook ou l’inclusion d’un webhook dans une campagne multicanal vous permet de déclencher des actions non liées à l’application en fournissant à d’autres systèmes et applications des informations en temps réel.

Vous pouvez utiliser les webhooks pour envoyer des informations à des systèmes, tels que Salesforce ou Marketo, ou à vos systèmes dorsaux. Par exemple, vous pourriez vouloir créditer les comptes de vos clients d’une promotion après qu’ils aient effectué un événement personnalisé un certain nombre de fois.

Étape 1 : Choisissez où créer votre message

Vous ne savez pas si votre message doit être envoyé via une campagne ou un Canvas ? Les campagnes sont mieux adaptées aux campagnes de communication simples et uniques, tandis que les Canvas sont mieux adaptés aux parcours client en plusieurs étapes.

• campagne
• canvas

Étape 2 : Créez votre webhook

Vous pouvez choisir de créer un webhook à partir de zéro, d’utiliser un modèle existant ou d’utiliser l’un de nos modèles existants. Ensuite, créez votre webhook dans l’onglet Compose de l’éditeur.

L’onglet Composer comprend les champs suivants :

• Langue
• URL du webhook
• Méthode HTTP
• Corps de la demande

Langue

L’internationalisation est prise en charge dans l’URL et le corps de la requête. Pour internationaliser votre message, sélectionnez Ajouter des langues et remplissez les champs requis.

Nous vous recommandons de sélectionner vos langues avant d’écrire votre contenu afin que vous puissiez remplir votre texte dans Liquid. Pour obtenir la liste complète des langues que vous pouvez utiliser, reportez-vous à la section Langues prises en charge.

URL du webhook

L’URL du webhook, ou l’URL HTTP, définit votre endpoint. L’endpoint est l’endroit où vous enverrez les informations que vous capturez dans le webhook.

Si vous désirez envoyer une information à un vendeur, le vendeur doit fournir cette URL dans la documentation de son API. Si vous envoyez des informations à vos propres systèmes, vérifiez auprès de votre équipe de développement ou d’ingénierie que vous utilisez l’URL correcte.

Braze autorise uniquement les URL qui communiquent sur les ports 80 (HTTP) et 443 (HTTPS) standard.

Utilisation de Liquid

Vous pouvez personnaliser les URL de vos webhooks à l’aide de Liquid. Il peut parfois arriver que certains endpoints vous demandent d’identifier un utilisateur pour fournir une information qui lui est spécifique au sein de l’URL. Lorsque vous utilisez Liquid, veillez à inclure une valeur par défaut pour chaque information spécifique à l’utilisateur que vous utilisez dans votre URL.

Méthode HTTP

La méthode HTTP que vous devez utiliser varie en fonction de l’endpoint auquel vous envoyez des informations. Dans la plupart des cas, vous utiliserez POST.

Corps de la demande

Le corps de la requête est l’information qui sera envoyée à l’URL que vous avez définie. Vous pouvez créer le corps de votre demande de webhook avec des paires clé-valeur JSON ou du texte brut.

Paires clé-valeur JSON

Les paires clé-valeur JSON vous permettent d’écrire facilement une requête pour un endpoint qui attend un format JSON. Vous ne pouvez l’utiliser qu’avec un endpoint qui attend une requête JSON. Par exemple, si votre clé est message_body, la valeur correspondante pourrait être Your order just arrived!. Après avoir entré la paire clé-valeur, le composeur configurera votre requête en syntaxe JSON et une prévisualisation de votre requête JSON se remplira automatiquement.

Vous pouvez personnaliser vos paires clé-valeur à l’aide de Liquid, par exemple en incluant tout attribut utilisateur, attribut personnalisé ou propriété d’événement dans votre requête. Vous pouvez par exemple ajouter le prénom et l’e-mail d’un client dans votre requête. Veillez à inclure une valeur par défaut pour chaque attribut.

Texte brut

L’option de texte brut permet une flexibilité pour écrire une requête pour un endpoint qui attend un corps de n’importe quel format. Par exemple, vous pouvez l’utiliser pour écrire une requête pour un endpoint qui s’attend à ce que votre requête soit au format XML.

La personnalisation et l’internationalisation à l’aide de Liquid sont prises en charge dans le texte brut.

Si vous attribuez la valeur application/x-www-form-url-encoded à l’en-tête de requête Content-Type, le corps de la requête doit être formaté sous la forme d’une chaîne de caractères codée en URL. Par exemple :

1
to={{custom_attribute.${example}}}&text=Your+order+just+arrived

Étape 3 : Configurer des paramètres supplémentaires

En-têtes de requête (optionnel)

Certains endpoints peuvent nécessiter d’ajouter des en-têtes à vos requêtes. Dans la section Composer du compositeur, vous pouvez ajouter autant d’en-têtes que nécessaire.

Les en-têtes de requête les plus courants sont les spécifications Content-Type (qui décrivent le type de données à attendre dans le corps, comme XML ou JSON) et les en-têtes d’autorisation qui contiennent vos informations d’identification auprès de votre fournisseur ou de votre système.

Les spécifications de type de contenu doivent utiliser la clé Content-Type. Des valeurs fréquentes sont application/json ou application/x-www-form-urlencoded.

Les en-têtes de permission doivent utiliser la clé Authorization. Les valeurs courantes sont Bearer {{YOUR_TOKEN}} ou Basic {{YOUR_TOKEN}} , où YOUR_TOKEN correspond aux identifiants communiqués par votre fournisseur ou votre système.

Étape 4 : Tester l’envoi de votre message

Avant de déployer votre campagne, Braze recommande de tester le webhook pour vous assurer que la requête est formatée correctement.

Pour ce faire, passez à l’onglet Test et envoyez un webhook de test. Vous pouvez tester le webhook en tant qu’utilisateur aléatoire, utilisateur spécifique (en saisissant son adresse e-mail ou son ID utilisateur externe) ou un utilisateur personnalisé avec les attributs de votre choix.

Après avoir envoyé le test de webhook, un dialogue s’affichera avec le message en réponse. Si la requête webhook échoue, consultez le message d’erreur pour obtenir de l’aide pour la résolution des problèmes de votre webhook. L’exemple suivant détaille la réponse d’un webhook ayant une URL de webhook invalide.

1
2
3
4
5
6
7
8
9
404 Not Found

{
  "error": {
    "message": "Unrecognized request URL. Please see https://lob.com/docs or email us at support@lob.com.",
    "status_code": 404
  }
}

Étape 5 : Créer le reste de votre campagne ou de votre Canvas

• campagne
• canvas

Étape 6 : Revue et déploiement

Quand vous avez fini de concevoir votre campagne ou votre Canvas, vérifiez ses détails, testez-le et envoyez-le !

Choses à savoir

Erreurs, logique de nouvel essai et temporisation

Les webhooks se fondent sur le fait que Braze effectue des requêtes à un endpoint externe et des erreurs de syntaxe, ou autres, peuvent se produire. La première étape pour éviter les erreurs de webhooks est de tester d’éventuelles erreurs de syntaxe dans vos campagnes webhooks et de vous assurer que les variables personnalisées ont une valeur par défaut. Cependant, les webhooks peuvent quand même échouer en raison de problèmes comme des clés API ayant expiré, des limites de débit ou des erreurs inattendues du serveur. Si votre webhook ne parvient pas à être envoyé, un message d’erreur est enregistré dans le journal d’activité des messages.

Cette description comprend l’heure à laquelle l’erreur est survenue, le nom de l’application et le message d’erreur :

Si le corps du message n’est pas assez clair au sujet de la source du problème, vous devriez consulter la documentation de l’endpoint d’API que vous utilisez. Elle fournit généralement une explication des codes d’erreur utilisés par l’endpoint ainsi que ce qui les entraîne le plus souvent.

Comme pour les autres campagnes, Braze assure le suivi de la réception/distribution de vos campagnes webhook et des conversions qui en découlent. Lorsque la requête webhook est envoyée, le serveur qui la reçoit renverra un code de réponse indiquant ce qui est arrivé à la requête.

Le tableau suivant résume les différentes réponses que le serveur peut envoyer, l’impact qu’elles ont sur l’analyse/analytique de la campagne et si, en cas d’erreur, Braze tentera de rediffuser la campagne :

Liste d’adresses IP autorisées

Lorsqu’un webhook est envoyé par Braze, les serveurs de Braze adressent des demandes de réseau à nos clients ou à des serveurs tiers. Grâce à la liste des adresses IP autorisées, vous pouvez vérifier que les demandes de webhook proviennent réellement de Braze, ce qui ajoute une couche de sécurité.

Braze enverra des webhooks depuis les adresses IP suivantes. Les adresses IP répertoriées sont automatiquement et dynamiquement ajoutées à toutes les clés API qui ont fait l’objet d’un abonnement à l’inscription sur la liste d’exclusion.

Utilisation des webhooks avec les partenaires de Braze

Il existe de nombreuses façons d’utiliser les webhooks, et avec nos partenaires technologiques (Alloys), vous pouvez utiliser les webhooks pour améliorer votre communication directement avec vos clients et utilisateurs.

Consultez :

• Messenger
• Remerge
• Lob.com
• Et bien d’autres de nos partenaires technologiques !