Braze Connector Setup Guide

[#1]

This article describes how to set up the Braze connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name	AudienceStream	EventStream
Track User	✓	✓
Delete User	✓	✓

Consent Categories

• Analytics
• Mobile
• Personalization

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

• API Endpoint
  • Required.
  • Select API endpoint for the instance your account is provisioned to.
  • For more information, see API Endpoints.
• API Key
  • Required.
  • Provide API key with "users.track" and "users.delete" permissions enabled.
  • Use Authentication to ensure that your API key is valid.
  • For more information, see App Group REST API Keys.

For additional information see Braze Documentation Braze Technology Partners: Tealium.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

The Track User action contains functionality that is the same for AudienceStream and EventStream. As a best practice, Tealium recommends using User Attribute features with AudienceStream and Event and Purchase features with EventStream. Use cases that do not fit these criteria may ignore this best practice.

Action - Track User

Tealium recommends mapping all User ID parameters for this section. When an action triggers, Tealium evaluates which User IDs to send to Braze for the best performance. When multiple IDs provided, the first non-blank values is selected based on the following priority order:

• User ID Parameters (Required)
• External ID
• Braze ID
• Alias Name
• Alias Label

For more information, see vendor documentation for User Track.

Parameter	Description
External ID	External ID of the user to be tracked. When importing Push Tokens, External ID and Braze ID should not be specified.
Braze ID	Braze ID of the user to be tracked. When importing Push Tokens, External ID and Braze ID should not be specified.
User Alias Name	The alias name of the user to be tracked. When specifying a user alias, Alias Name and Alias Label should both be set.
User Alias Label	The alias label of the user to be tracked. When specifying a user alias, Alias Name and Alias Label should both be set.

User Attributes Parameters (Optional)

Tealium recommends using the Braze best practice of sending only changed user attributes and avoiding sending unchanged attributes. You can do this using Visit and Visitor attribute enrichments and rules that recognize when an attribute has changed. For more information, see Enrichment Rules.

Parameter	Description
Country	The country of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Current Location - Latitude	The current latitude for the user to be tracked Empty values are converted to null and removed from the Braze user profile..
Current Location - Longitude	The current longitude for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Date of First Session	The date of the first session of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Date of Last Session	The date of the last session of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Date of Birth	The date of birth for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Email Address	The email address for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Email Subscription Status	The email subscription status for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Facebook	The Facebook account for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
First Name	The first name of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Gender	The gender of the user to be tracked. Values are Male (m) or Female (f). Empty values are converted to null and removed from the Braze user profile.
Home City	The home city for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Image URL	Optional The URL for the user's image. Empty values are converted to null and removed from the Braze user profile.
Language	The language preference of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Last Name	The last name of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Marked Email As Spam At	User marked email as spam. Empty values are converted to null and removed from the Braze user profile.
Phone Number	The telephone number of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Push Subscription Status	The Push Subscription status of the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Push Tokens ID Array	Array. The Push Token ID for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Push Tokens Array	Push tokens array. Empty values are converted to null and removed from the Braze user profile.
Push Tokens Device ID Array	The Push Token Device ID for the user's device. Empty values are converted to null and removed from the Braze user profile.
Time Zone	The time zone for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Twitter	The Twitter account for the user to be tracked. Empty values are converted to null and removed from the Braze user profile.
Update Existing Only (Users)	Optional Values are true or false. If no user value exists, one is created by default. If set to true, only existing users are updated and no new users are created. Empty values are converted to null and removed from the Braze user profile.

Modify User Attribute Parameters (Optional)

Parameter	Description
Modify User Attributes	Increment Integer attributes by positive or negative integers. Modify Array attributes by adding or removing values from existing arrays.

Event Parameters (Optional)

To map data for events, you must map a value for the Braze event name. If the Tealium and Braze event names are not mapped, no data is sent to Braze.

Parameter	Description
App ID	The User App ID to be tracked.
Name	Required The application name to be tracked.
Time	Time
Update Existing Only (Events)	Optional Values are true or false. If no event value exists, one is created by default. If set to true, only existing events are updated and no new events are created Map Array type attributes to add multiple events. Array type attributes must be of equal length. Single value attributes can be used and will apply to each event.

Purchase Parameters (Optional)

To map data for purchases, you must map the values for Product ID, Currency, and Price.

Example:

The following code sample shows a Braze best practice example for receiving a single Tealium purchase event containing purchases for multiple products:

// event to Tealium:
{
  [...]
  "tealium_event": "purchase,
  "product_name": ["Backpack","Pencil","Notebook"],
  "product_quantity": [1,5,3],
  "product_category": ["Travel","Office","Office"],
  "product_price": [39.95,1.99,3.99],
  "order_currency": "USD"
}

Map the corresponding product arrays to Braze as follows:

• product_name > Product ID
• product_quantity > Quantity
• product_price > Price

The results of this example sends the following purchases object to Braze, representing each product accordingly:

// payload to Braze via Tealium Connector:
{
  "purchases": [
    {
      "external_id" : "user1",
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "Backpack",
      "currency" : "USD",
      "price" : 39.95,
      "time" : "2013-07-16T19:20:30+01:00",
    },
    {
      "external_id" : "user1",
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "Pencil",
      "currency" : "USD",
      "price" : 1.99,
      "time" : "2013-07-16T19:20:30+01:00",
    },
    {
      "external_id" : "user1",
      "app_id" : "11ae5b4b-2445-4440-a04f-bf537764c9ad",
      "product_id" : "Backpack",
      "currency" : "USD",
      "price" : 3.99,
      "time" : "2013-07-16T19:20:30+01:00",
    }
  ]
}

Parameter	Description
App ID	The Event Application ID to be tracked.
Product ID	Required for every mapped purchase.
Currency	Required for every mapped purchase.
Price	Required for every mapped purchase.
Quantity	Map Array type attributes to add multiple purchase items. Array type attributes must be of equal length.
Purchase Time	Time of purchase. Automatically set to "now" unless explicitly mapped.
Update Existing Only (Purchases)	Optional Values are true or false. If no purchase value exists, one is created by default. If set to true, only existing purchases are updated and no new purchases are created. Map Array type attributes to add multiple events. Array type attributes must be of equal length. Single value attributes can be used and will apply to each event.

Action - Delete User

Parameters

Parameter	Description
External ID	Required Must be mapped. External ID of the user to delete. When multiple IDs are specified, the first non-blank values is selected based on the following priority order: External ID Braze ID Alias Name Alias Label For more information, see User Delete Endpoint.
Braze ID	Required Must be mapped. Braze ID of the user to delete. When multiple IDs are specified, the first non-blank values is selected based on the following priority order: External ID Braze ID Alias Name Alias Label Must include either External ID or Braze ID.
User Alias Name	Required The alias name of the user to be deleted. When specifying a user alias, Alias Name and Alias Label should both be set. For more information, see User Delete Endpoint.
User Alias Label	Required The alias label of the user to be deleted. When specifying a user alias, Alias Name and Alias Label should both be set.

Frequently Asked Questions

How does this connector complement or replace other Braze integrations with Tealium?

In addition to the Track User API, Braze has additional data collection methods, both of which support mapping of user attributes in Braze. Tealium supports Braze SDKs for Web and Native Mobile in the following two independent, but similar integrations:

• Braze Web SDK Tag Setup, Braze Initial SDK Setup
• Tealium Remote Command for Braze on Android and iOS/Swift (Learn more)

These integrations are alternative methods used for Braze to collect user behavior data that is similar to the data collected by the Events and Purchases features of the Braze connector.