Se connecter à l’API Customer Data de Movable Ink

L’intégration de l’API Customer Data de Braze et Movable Ink permet aux marketeurs d’activer les données d’événements clients stockées dans Braze pour générer du contenu personnalisé au sein de Movable Ink.

Movable Ink est capable d’ingérer des événements comportementaux depuis Braze via leur API Customer Data. Les événements sont stockés sur les profils utilisateur en fonction de l’identifiant utilisateur unique (UUID) transmis à Movable Ink.

Pour plus d’informations sur les Stories, l’API Customer Data de Movable Ink et la manière dont Movable Ink exploite les données comportementales, consultez les articles suivants du centre d’assistance :

• Alimenter le contenu avec des données comportementales
• Introduction et guide de l’API Customer Data
• FAQ : API Customer Data

Conditions préalables

Intégration

Étape 1 : Créer une campagne webhook dans Braze

Étape 1a : Créer une nouvelle campagne

1. Dans Braze, créez une campagne webhook.
2. Donnez un nom et une description facultative à votre campagne.
3. Sélectionnez Blank Template comme modèle.

Étape 1b : Ajouter vos identifiants API Customer Data

1. Dans le champ Webhook URL, saisissez l’URL de l’endpoint Movable Ink.

2. Sélectionnez l’onglet Settings.
3. Ajoutez les en-têtes de requête suivants en tant que paires clé-valeur :

Étape 1c : Configurer votre payload

1. Retournez dans l’onglet Compose.
2. Pour votre Request Body, créez votre propre corps de requête avec des paires clé-valeur JSON ou saisissez votre payload d’événement en tant que texte brut. Reportez-vous aux exemples de payloads pour des exemples d’événements eCommerce standard.

Étape 1d : Tester votre webhook

Vous devrez partager un exemple de payload avec votre équipe Expérience Client de Movable Ink. Vous pouvez générer ce payload dans l’onglet Test en fonction du payload que vous avez construit.

Important

Movable Ink recommande d’attendre pour tester votre webhook dans Braze jusqu’à ce que votre équipe Expérience Client de Movable Ink ait confirmé qu’elle a terminé le mappage et est prête à recevoir un test. Si ce mappage n’est pas terminé, vous recevrez probablement une erreur lors du test.

Pour tester votre webhook, procédez comme suit :

1. Sélectionnez l’onglet Test.
2. Prévisualisez le message en tant qu’utilisateur pour voir un exemple de payload d’événement pour cet utilisateur. Vous pouvez choisir entre prévisualiser en tant qu’utilisateur aléatoire, utilisateur spécifique ou utilisateur personnalisé.
3. Si tout semble correct, cliquez sur Send test pour envoyer une requête de test.

Étape 2 : Finaliser la configuration de votre campagne

Étape 2a : Planifier votre campagne

Lorsque vous avez terminé de composer et de tester le webhook, planifiez votre campagne.

Braze prend en charge les livraisons planifiées, par événement et déclenchées par API. La livraison par événement est généralement la mieux adaptée à la plupart des cas d’utilisation d’événements comportementaux. Pour toute question sur ce qui convient le mieux à votre cas d’utilisation, contactez vos gestionnaires de la satisfaction client Braze et Movable Ink.

Pour la livraison par événement :

1. Spécifiez l’action de déclenchement. Il s’agit de l’événement qui déclenchera le webhook vers Movable Ink.
2. Assurez-vous que le Schedule Delay est réglé sur Immediately. Les données d’événement doivent être envoyées à Movable Ink immédiatement après l’événement, sans délai.
3. Définissez la durée de la campagne en spécifiant une heure de début. Une heure de fin n’est probablement pas nécessaire, mais elle peut être définie si le cas d’utilisation l’exige.

Remarque

Pour vous assurer que les données sont diffusées en temps réel vers Movable Ink, ne sélectionnez pas Send campaign to users in their local time zone.

Étape 2b : Spécifier votre audience

Ensuite, déterminez quels utilisateurs vous souhaitez cibler pour cette campagne. Pour plus de détails, consultez Ciblage des utilisateurs.

Veillez à ne pas utiliser de test A/B dans votre campagne en décochant la case Control Group. Si un groupe de contrôle est inclus, les données d’un pourcentage d’utilisateurs ne seront pas envoyées à Movable Ink. L’intégralité de votre audience devrait être dirigée vers la variante plutôt que vers le groupe de contrôle.

Étape 2c : Choisir des événements de conversion (facultatif)

Si vous le souhaitez, vous pouvez attribuer des événements de conversion à cette campagne dans Braze.

Cependant, étant donné que le webhook est uniquement destiné à diffuser des données, l’attribution à ce niveau est probablement moins utile que l’analyse de l’attribution au niveau de la campagne une fois que les données comportementales de Braze sont utilisées pour personnaliser le contenu.

Étape 3 : Lancer la campagne

Vérifiez votre configuration de webhook et lancez votre campagne.

Considérations

S’aligner sur un identifiant utilisateur unique

Assurez-vous que la valeur de l’identifiant utilisateur unique (UUID) que vous utilisez comme mi_u est disponible dans Braze et peut être incluse dans les payloads d’événements envoyés à Movable Ink.

Cela garantit que les événements comportementaux auxquels Movable Ink fait référence lors de la génération d’une image sont associés au même client pour lequel les événements comportementaux ont été reçus. Si la valeur UUID n’est pas identique à l’external_id de Braze, l’UUID doit être capturé et transmis à Braze en tant qu’attribut ou dans les propriétés d’événement d’un événement Braze pour exploiter cet identifiant.

Braze suit le comportement des utilisateurs sur plusieurs plateformes (telles que le web et les applications mobiles), de sorte qu’un seul utilisateur peut avoir plusieurs identifiants anonymes distincts. Ces identifiants peuvent être fusionnés dans le profil utilisateur unique connu de Stories lorsqu’un événement identify est envoyé à Movable Ink, à condition que l’événement identify inclue à la fois un identifiant anonyme et l’identifiant unique connu.

Une fois que Movable Ink reçoit un user_id pour un utilisateur donné, tous les événements futurs pour cet utilisateur doivent inclure ce même user_id.

Partage des payloads d’événements avec Movable Ink

Avant de configurer le connecteur vers l’API Customer Data de Movable Ink, assurez-vous de partager vos payloads d’événements avec l’équipe Expérience Client de Movable Ink. Cela permet à Movable Ink de mapper vos événements sur leur schéma d’événements et évitera tout appel API rejeté ou échoué.

Vous pouvez générer un payload d’événement dans Braze en utilisant n’importe quelles propriétés d’événement. Générez un exemple de payload pour un utilisateur aléatoire ou en recherchant un ID utilisateur spécifique. Reportez-vous à l’étape 1d ci-dessus pour plus de détails.

Partagez cet exemple de payload avec votre équipe Expérience Client de Movable Ink. Assurez-vous qu’il ne contient aucune information personnelle sensible identifiable (telle qu’une adresse e-mail, un numéro de téléphone ou des dates de naissance complètes).

Pour en savoir plus sur les propriétés d’événements personnalisés et le format attendu des données contenues dans les propriétés, consultez Propriétés d’événements personnalisés.

Utilisateurs connus et utilisateurs anonymes

Dans Braze, les événements peuvent être enregistrés sous un profil utilisateur anonyme. Les identifiants liés au profil utilisateur lors de l’enregistrement des événements dépendent de la manière dont l’utilisateur a été créé (via le SDK Braze ou les API) et de son stade actuel dans le cycle de vie utilisateur.

Transférer uniquement les événements Braze pour les utilisateurs connus

Dans votre campagne webhook, utilisez le filtre External User ID pour cibler uniquement les utilisateurs qui possèdent un external_id avec le filtre External User ID is not blank.

Transférer les événements Braze pour les utilisateurs anonymes et connus

Si vous souhaitez transférer les événements Braze d’utilisateurs anonymes (utilisateurs avant qu’un external_id ne soit attribué à leur profil), vous devrez décider quel identifiant utiliser comme anonymous_id pour Movable Ink jusqu’à ce qu’un external_id soit disponible. Choisissez un anonymous_id qui restera constant sur votre profil utilisateur Braze. Vous pouvez utiliser la logique Liquid dans le corps du webhook pour décider s’il faut transmettre un anonymous_id ou un user_id.

Pour en savoir plus, consultez les exemples de webhooks sous exemples de payloads.

Exemples de payloads

Événement de consultation de produit

• example braze trigger event
• expected movable ink request payload
• example webhook

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "events": [
    {
      "email": "[email protected]",
      "name": "Product Viewed",
      "time": "2023-12-06T19:20:45+01:00",
      "properties": {
        "categories": [
          {
            "id": "Bathroom",
            "url": "https://example.com/cat/bathroom"
          }
        ],
        "meta": {
          "color": "green"
        },
        "title": "All-Purpose Cleaning Wipes",
        "price": 1.99,
        "id": "56544",
        "url": "https://www.example.com/variants_id/5f08cb918dcc595aa74b0fbc"
      }
    }
  ]
}

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
curl --location --request POST 'https://collector.movableink-dmz.com/behavioral/{{key}}' \
--header 'Authorization: Basic {{authorization}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "anonymous_id": "123-abc-678",
  "event": "product_viewed",
  "properties": {
    "categories": [
      {
        "id": "Bathroom",
        "url": "https://example.com/cat/bathroom"
      }
    ],
    "meta": {
      "color": "green"
    },
    "title": "All-Purpose Cleaning Wipes",
    "price": 1.99,
    "id": "56544",
    "url": "https://www.example.com/variants_id/5f08cb918dcc595aa74b0fbc"
  },
  "timestamp": 1257894000000,
  "timezone": "America/New_York",
  "type": "track",
  "user_id": "5c3aa83113dd490100d3d8d7"
}'

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
// Converts the timestamp of "now" to seconds since 1970 and assigns it to a local variable "timestamp"
{% assign timestamp = "now" | date: "%s" %}

// Example of md5 hashing the email address to use as the anonymous_id
{% assign anon_id = {{${email_address}}} | md5 %}

// Condition logic to determine which identifier to use. If an external_id is available use that, otherwise use the anonymous_id
{% if {{${user_id}}} %}
{% capture user_identifier %}"user_id": "{{${user_id}}}"{% endcapture %}
{% else %}
{% capture user_identifier %}"anonymous_id": "{{anon_id}}"{% endcapture %}
{% endif %}

{
  {{user_identifier}}
  "event": "product_viewed",
  "properties": {
    "categories": [
      {
        "id": "{{event_properties.${categories}[0].id}}",
        "url": "{{event_properties.${categories}[0].url}}"
      }
    ],
    "meta": {
      "color": "{{event_properties.${meta}.color}}"
    },
    "title": "{{event_properties.${title}}}",
    "price": "{{event_properties.${price}}}",
    "id": "{{event_properties.${id}}}",
    "url": "{{event_properties.${url}}}"
  },
  "timestamp": "{{timestamp}}",
  "timezone": "{{${time_zone}}}",
  "type": "track",
}

Événement de consultation de catégorie

• example braze trigger event
• expected movable ink request payload
• example webhook

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "events": [
    {
      "external_id": "123456789",
      "name": "Category Viewed",
      "time": "2023-12-06T19:20:45+01:00",
      "properties": {
        "id": "bathroom-1",
        "title": "Bathroom Stuff",
        "url": "https://www.example.com/categories/bathroom"
      }
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --location --request POST 'https://collector.movableink-dmz.com/behavioral/{{key}}' \
--header 'Authorization: Basic {{authorization}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "anonymous_id": "123-abc-678",
  "event": "category_viewed",
  "properties": {
    "id": "bathroom-1",
    "title": "Bathroom Stuff",
    "url": "https://www.example.com/categories/bathroom"
  },
  "timestamp": 1257894000000,
  "timezone": "America/New_York",
  "type": "track",
  "user_id": "5c3aa83113dd490100d3d8d7"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Converts the timestamp of "now" to seconds since 1970 and assigns it to a local variable "timestamp"
{% assign timestamp = "now" | date: "%s" %}

{
  "event": "category_viewed",
  "properties": {
    "id": "{{event_properties.${id}}}",
    "title": "{{event_properties.${title}}}",
    "url": "{{event_properties.${url}}}"
  },
  "timestamp": "{{timestamp}}",
  "timezone": "{{${time_zone}}}",
  "type": "track",
  "user_id": "{{${user_id}}}"
}

Événement d’identification

• example braze trigger event
• expected movable ink request payload
• example webhook

1
2
3
4
5
6
7
8
9
{
  "events": [
    {
      "external_id": "123456789",
      "name": "Account Created",
      "time": "2023-12-06T19:20:45+01:00"
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://collector.movableink-dmz.com/behavioral/{{key}}' \
--header 'Authorization: Basic {{authorization}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "anonymous_id": "jg0iq5gd30dqpwn8zmx05p06mzjmjir4r8",
  "timestamp": 1257894000000,
  "timezone": "America/New_York",
  "type": "identify",
  "user_id": "mycustomerid123"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Converts the timestamp of "now" to seconds since 1970 and assigns it to a local variable "timestamp"
{% assign timestamp = "now" | date: "%s" %}

// Example of md5 hashing the email address to use as the anonymous_id
{% assign anon_id = {{${email_address}}} | md5 %}

{
  "anonymous_id": "{{anon_id}}",
  "timestamp": "{{timestamp}}",
  "timezone": "{{${time_zone}}}",
  "type": "identify",
  "user_id": "{{${user_id}}}"
}