Créer une transformation

Braze Data Transformation vous permet de créer et de gérer des intégrations webhook pour automatiser le flux de données depuis des plateformes externes vers Braze. Ces intégrations de webhooks peuvent ensuite faciliter des cas d’utilisation marketing encore plus sophistiqués. Vous pouvez créer votre transformation de données à partir d’un code par défaut, ou en utilisant notre bibliothèque de modèles dédiée pour vous aider à démarrer avec certaines plateformes externes.

Conditions préalables

Étape 1 : Identifier une plateforme source

Identifiez une plateforme externe que vous souhaitez connecter à Braze et vérifiez que la plateforme prend en charge les webhooks. Ces paramètres sont parfois appelés “notifications API” ou “demandes de service web”.

Voici un exemple de webhook de Typeform, qui est configurable en se connectant à leur plateforme :

Étape 2 : Créer une transformation

In the Braze dashboard, go to Data Settings > Data Transformation.

Select Create Transformation to name your transformation, then choose your editing experience.

Select Use a template to browse through a template library, including Data Transformation use cases. Or, select Start from scratch to load a default code template.

If you’re starting from scratch, choose a destination for your transformation. You can still insert a code template from the template library.

After creating your transformation, you’ll see the detailed view of the transformation. Here, you can view the most recent webhook received for this transformation under Webhook details and a space to write your transformation code under Transformation code.

Étape 3 : Envoyez un webhook de test (recommandé)

Cette étape est facultative, mais nous vous recommandons d’envoyer un webhook de test depuis votre plateforme source vers votre transformation nouvellement créée.

1. Copiez l’URL de votre transformation.
2. Dans votre plateforme source, trouvez une capacité “Envoyer un test” pour qu’elle génère un exemple de webhook à envoyer à cette URL.
   • Si votre plateforme source vous demande un type de requête, sélectionnez POST.
   • Si votre plateforme source propose des options d’authentification, sélectionnez Aucune authentification.
   • Si votre plateforme source demande des secrets, sélectionnez Aucun secret.
3. Actualisez votre page dans le tableau de bord de Braze pour voir si le webhook a été reçu. S’il a été reçu, vous devriez voir un webhook payload sous Most recent webhook.

Voici à quoi cela ressemble pour Typeform :

Étape 4 : Écrire le code de transformation

Si vous avez peu ou pas d’expérience avec le code JavaScript ou si vous préférez des instructions plus détaillées, suivez les instructions de l’onglet Débutant - POST : Suivre les utilisateurs ou Débutant - PUT : mettre à jour plusieurs produits du catalogue pour l’écriture de votre code de transformation.

Si vous êtes développeur ou si vous avez de l’expérience avec le code JavaScript, suivez les instructions de l’onglet Avancé - POST : suivi utilisateur pour obtenir des instructions générales sur l’écriture de votre code de transformation.

• débutants - utilisateurs de la voie ferrée
• débutant - mise à jour des éléments du catalogue
• avancé - suivi des utilisateurs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// Here, we will define a variable, "brazecall", to build up a `/users/track` request
// Everything from the incoming webhook is accessible via the special variable "payload"
// So you can template in desired values in your `/users/track` request with dot notation, such as payload.x.y.z

let brazecall = {
  "attributes": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "attribute_1": payload.attribute_1
    }
  ],
  "events": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "name": payload.event_1,
      "time": new Date(),
      "properties": {
        "property_1": payload.event_1.property_1
      }
    }
  ],
  "purchases": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "product_id": payload.product_id,
      "currency": payload.currency,
      "price": payload.price,
      "quantity": payload.quantity,
      "time": payload.timestamp,
      "properties": {
        "property_1": payload.purchase_1.property_1
      }
    }
  ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// This is a default template that you can use as a starting point
// Feel free to delete this entirely to start from scratch, or to edit specific components

// First, this code defines a variable, "brazecall", to build a PUT /catalogs/{catalog_name}/items request
// Everything from the incoming webhook is accessible via the special variable "payload"
// As such, you can template in desired values in your request with JS dot notation, such as payload.x.y.z

let brazecall = {
  // For Braze Data Transformation to update Catalog items, the special variable "catalog_name" is required
  // This variable is used to specify the catalog name which would otherwise go in the request URL
  "catalog_name": "catalog_name",
  
  // After defining "catalog name", construct the Update Multiple Catalog Items request as usual below
  // Documentation for the destination endpoint: https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/asynchronous/put_update_catalog_items/
  "items": [
    {
      "id": payload.item_id_1,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    },
    {
      "id": payload.item_id_2,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    },
    {
      "id": payload.item_id_3,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    }
  ]
};

// After the request body is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

Étape 5 : Suivez votre transformation

Après avoir activé votre transformation, consultez les analyses sur la page principale des transformations pour obtenir un résumé des performances.

• Demandes entrantes : Il s’agit du nombre de webhooks reçus à l’URL de cette transformation. Si le nombre de demandes entrantes est égal à 0, cela signifie que votre plateforme source n’a envoyé aucun webhook ou que la connexion ne peut pas être établie.
• Livraisons : Après avoir reçu les demandes entrantes, la transformation des données applique votre code de transformation pour l’envoyer à la destination de Braze que vous avez sélectionnée.

Il est souhaitable que 100 % des demandes entrantes aboutissent à une réception/distribution. Le nombre de livraisons ne dépassera jamais le nombre de demandes entrantes.

Résolution des problèmes

Pour une surveillance et une résolution des problèmes plus détaillées, consultez la page Journaux pour des journaux spécifiques, où sont consignées les 1 000 dernières demandes entrantes adressées à toutes les transformations de vos espaces de travail. Vous pouvez sélectionner chaque journal pour afficher le corps de la requête entrante, la sortie de la transformation et le corps de la réponse de la destination de la transformation.

S’il n’y a pas de réception/distribution, vérifiez que votre code de transformation ne contient pas d’erreurs de syntaxe et confirmez que le code se compile. Vérifiez ensuite si la sortie est une demande de destination valide.

Une réception/distribution inférieure au nombre de demandes entrantes indique qu’au moins certains webhooks sont délivrés avec succès. Consultez les journaux de transformation pour trouver des exemples d’erreurs et vérifiez si la sortie de la transformation est conforme aux attentes. Il est possible que votre code de transformation ne prenne pas en compte toutes les variations des webhooks reçus.