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é par le biais d’une campagne ou d’un canvas ? Les campagnes sont plus adaptées aux campagnes d’envoi de messages simples et uniques, tandis que les Canevas sont plus adaptés aux parcours utilisateurs en plusieurs étapes.

• campaign
• 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

!L’onglet “Compose” avec un exemple de modèle de webhook.

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 de rédiger votre contenu afin de pouvoir remplir votre texte à l’endroit voulu dans le Liquid. Pour obtenir la liste complète des langues que vous pouvez utiliser, reportez-vous à la section Langues prises en charge.

Si vous ajoutez du texte dans une langue qui s’écrit de droite à gauche, notez que l’aspect final des messages écrits de droite à gauche dépend largement de la manière dont les fournisseurs de services les restituent. Pour connaître les meilleures pratiques en matière d’élaboration de messages de droite à gauche qui s’affichent le plus précisément possible, reportez-vous à la section Création de messages de droite à gauche.

URL du webhook

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

Si vous souhaitez envoyer des informations à un fournisseur, celui-ci 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 n’autorise que les URL qui communiquent sur les ports standard 80 (HTTP) et 443 (HTTPS).

Utilisation du liquide

Vous pouvez personnaliser les URL de vos webhooks à l’aide de Liquid. Parfois, certains endpoints peuvent vous demander d’identifier un utilisateur ou de fournir des informations spécifiques à l’utilisateur dans le cadre de votre 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 spécifiée. 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 peut être Your order just arrived!. Après avoir saisi votre paire clé-valeur, le compositeur configurera votre demande en syntaxe JSON, et un aperçu de votre demande JSON s’affichera automatiquement.

!Le corps de la demande est constitué de paires clé-valeur JSON.

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. Par exemple, vous pouvez inclure le prénom et l’e-mail d’un client dans votre demande. Veillez à inclure une valeur par défaut pour chaque attribut.

Texte brut

L’option texte brut vous permet d’é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.

Un exemple de corps de requête avec du texte brut utilisant Liquid.](/docs/fr/assets/img_archive/webhook_rawtext.png?bf17237fbbf1ba70de38934d6c262d4f)

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

!Chaîne de caractères codée en URL dans le corps de la requête.

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

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

Certains endpoints peuvent exiger que vous incluiez des en-têtes dans votre demande. Dans la section Composer du compositeur, vous pouvez ajouter autant d’en-têtes que nécessaire.

Exemples d’en-têtes de requête pour les clés “Authorization” et “Content-Type”.](/docs/fr/assets/img_archive/webhook_request_headers_example.png?4715c97a5b7a3437fa7555e4f8ec8298)

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. Les valeurs courantes sont application/json ou application/x-www-form-urlencoded.

Les en-têtes d’autorisation doivent utiliser la clé Authorization. Les valeurs courantes sont Bearer {{YOUR_TOKEN}} ou Basic {{YOUR_TOKEN}} , où YOUR_TOKEN correspond aux informations d’identification fournies par votre fournisseur ou votre système.

Étape 4 : Testez l’envoi de votre message

Avant de mettre votre campagne en ligne/instantanée, Braze vous recommande de tester le webhook pour vous assurer que la demande 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 externe) ou utilisateur personnalisé avec les attributs de votre choix.

Après avoir envoyé le webhook de test, une boîte de dialogue s’affiche avec le message de réponse. Si la demande de webhook n’aboutit pas, consultez le message d’erreur pour obtenir de l’aide dans la résolution des problèmes de votre webhook. L’exemple suivant détaille la réponse d’un webhook dont l’URL n’est pas valide.

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 [email protected].",
    "status_code": 404
  }
}

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

• campaign
• canvas

Étape 6 : Examiner et déployer

Une fois que vous avez fini de créer la dernière partie de votre campagne ou de votre canvas, passez en revue ses détails, testez-le, puis envoyez-le !

Ce qu’il faut savoir

Erreurs, logique de réessai et délais d’attente

Les webhooks reposent sur les serveurs Braze qui effectuent des requêtes vers un endpoint externe, et des erreurs peuvent occasionnellement se produire. Les erreurs les plus courantes sont les erreurs de syntaxe, les clés API expirées, les limites de débit et les problèmes inattendus côté serveur. Avant d’envoyer une campagne webhook :

• Testez votre webhook pour détecter les erreurs de syntaxe
• Veillez à ce que les variables personnalisées aient des valeurs par défaut

Si votre webhook ne parvient pas à être envoyé, un message d’erreur est enregistré dans le journal d’activité des messages et contient des informations telles que l’horodatage de l’erreur, le nom de l’application et des détails sur l’erreur.

Erreur de webhook avec le message “Un jeton d’accès actif doit être utilisé pour demander des informations sur l’utilisateur actuel”.](/docs/fr/assets/img_archive/webhook-error.png?27ca392cc5bec5126e9ab4375324438e)

Si le message d’erreur n’est pas suffisamment clair quant à la source de l’erreur, vous devez consulter la documentation du point de terminaison de l’API que vous utilisez. Elles fournissent généralement une explication des codes d’erreur utilisés par l’endpoint, ainsi que de leur cause habituelle.

Codes de réponse et logique de relance

Lorsque la demande de webhook est envoyée, le serveur destinataire renvoie un code de réponse indiquant ce qui s’est passé avec la demande. 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 :

Résolution des problèmes et détails supplémentaires sur les erreurs

Pour obtenir des explications détaillées, des étapes de dépannage et des conseils sur la résolution d’erreurs spécifiques de webhook, reportez-vous à la section Dépannage des demandes de webhook et de contenu connecté. Vous trouverez également plus d’explications sur le fonctionnement de notre système de détection des hôtes malsains et sur la manière dont Braze fournit des notifications d’erreur par le biais d’e-mails automatisés et d’une journalisation supplémentaire dans Braze Currents.

Liste d’autorisation IP

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 à l’IP allowlisting, vous pouvez vérifier que les demandes de webhook proviennent bien de Braze, ce qui ajoute une couche de sécurité.

Braze enverra des webhooks à partir des 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.

• united states (us)
• european union (eu)
• australia (au)
• indonesia (id)

Utiliser les 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.

Vérifiez :

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