Braze Connector Setup Guide

Connector Actions

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 Braze API Endpoints.
• API Key
  Required: Provide API key with permission enabled for users.track and users.delete.
  For more information, see Braze App Group REST API Keys.

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

Action Settings - Parameters and Options

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

The Track User action contains the same functionality for both AudienceStream and EventStream. As a best practice, set the user attribute mappings for the AudienceStream action and the event and purchase mappings for the EventStream action.

Action - Track User (Batch/Non-Batch)

We recommend mapping as many ID parameters as possible. When an action triggers with multiple IDs mapped, the first non-blank value is selected based on the following priority order:

• External ID
• Braze ID
• Alias Name/Alias Label

For more information, see Braze API: User Track.

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 75
• Max time since oldest request: 10 minutes
• Max size of requests: 1 MB

User ID

User Attributes

We recommend following the Braze best practice of only sending 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.

Empty values are converted to null and removed from the Braze user profile.

Modify User Attributes

Modify numeric user attributes with the following operations:

• Increment (accepts positive or negative values)
• Decrement
• Add

Modify array attributes by adding or removing values from existing arrays.

Events

An event name must be mapped to Name.

Map array attributes of equal length to send multiple events. Single value attributes can be used and will apply to each event.

Event Template Variables

Provide template variables as data input (see:template variables).

Name nested template variables with the dot notation (Example: items.name).

Nested template variables are typically built from data layer list attributes.

Event Templates

Provide templates to be referenced in Body Data (see:Trimou templating engine).

Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}).

Purchases

To map data for purchases, you must map the values for Product ID, Currency, and Price. Map array attributes of equal length to send multiple events. Single value attributes can be used and will apply to each event.

The following code sample shows a Braze best practice example for receiving a single 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 array attributes to the Braze parameters:

• 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",
    }
  ]
}

Purchase Template Variables

Provide template variables as data input (see:template variables).

Name nested template variables with the dot notation (Example: items.name).

Nested template variables are typically built from data layer list attributes.

Purchase Templates

Define a template to send nested objects.

When a template is defined, the mappings from the Purchases section are ignored.

Provide templates to be referenced in Body Data (see:Trimou templating engine).

Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}).

Action - Delete User (Non-Batch)

Only one of External ID, Braze ID, and User Alias is needed in each action. However, we recommend mapping as many attributes as you can. When IDs are mapped, the first non-blank value is selected based on the following priority order:

• External ID
• Braze ID
• Alias Name
• Alias Label

For more information, see Braze API: User Delete Endpoint.

Parameters

Action - Update User Subscription Group Status (Non-Batch)

For more information, see Braze API: Subscription Groups Endpoints.

Parameters

Update User Subscription Group Status Across Multiple Subscription Groups (Non-Batch)

Parameters

Attributes

Send Campaign Message

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 10 minutes
• Max size of requests: 1 MB

Parameters

Send Canvas Message

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 10 minutes
• Max size of requests: 1 MB

Parameters

Send Transactional Email

Parameters

Identify User

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 10 minutes
• Max size of requests: 1 MB

Parameters

Frequently Asked Questions

How does this connector work with other Braze integrations?

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 in the event and purchase actions of the connector.