Remote Command: Braze | Integrations |Tealium Developer Docs

Requirements

Braze API key
Tealium for Android or Tealium for iOS in your app
Braze Remote Command tag in Tealium iQ Tag Management

How It Works

The Braze integration uses the native Braze SDK, a remote command module that wraps the Braze methods, and the Braze Remote Command tag that translates event tracking into native Braze calls. This solution leverages the convenience of Tag Management to configure a native Braze implementation without having to add vendor-specific code to your app.

Adding the Braze remote command module to your app automatically installs and builds the required Braze libraries. If you are using a dependency manager installation, there is no need to install the Braze SDK separately.

Install

Dependency Manager

We recommend using one of the following dependency managers for installation:

If you are using the Tealium iOS (Objective-C) library, use the manual installation method. The CocoaPods and Carthage options are only available if you are using the Tealium iOS (Swift) library.

To install Braze remote commands for iOS using CocoaPods:

Remove tealium-swift and pod "Appboy-iOS-SDK" if they exist in your Podfile. The dependency for tealium-swift is already included in the TealiumBraze framework.

Add the following dependency to your Podfile:

pod "TealiumBraze"

The TealiumBraze pod includes the following TealiumSwift dependencies:

'tealium-swift/Core'
'tealium-swift/TealiumDelegate'
'tealium-swift/TealiumRemoteCommands'
'tealium-swift/TealiumTagManagement'

Add any other required modules manually to your Podfile, such as the following:
```
'tealium-swift/TealiumLogger'
'tealium-swift/TealiumLifecycle'
'tealium-swift/TealiumAppData'
```
Learn more about the recommended modules for iOS.
Import the modules TealiumSwift and TealiumBraze in your TealiumHelper file, and any other files that access the Tealium class, or the Braze remote command.

To install Braze remote commands for iOS using Carthage:

Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumBraze framework.
Remove the following line if it exists in your Cartfile:
```
github "Appboy/Appboy-iOS-SDK"
```

Add the following dependency to your Cartfile:

github "tealium/tealium-ios-braze-remote-command"

Tealium for Swift SDK (version 1.6.5+) requires the TealiumDelegate module to be included with your installation.

To install Braze remote commands for Android using Maven:

Install Tealium’s Android SDK, if you haven’t done so already.
Import both the Braze SDK and Tealium-Braze remote commands by adding the following dependencies in your app project’s build.gradle file:
```
dependencies {
  implementation 'com.tealium.remotecommands:braze:0.0.3'
  implementation 'com.appboy:android-sdk-ui:3.8.0'
}
```

Manual (iOS)

The manual installation for Braze remote commands requires one of the following iOS libraries to be installed:

To install the Braze remote commands for your iOS project:

Install the Braze SDK, if you haven’t already done so.
Clone the Tealium iOS Braze remote command repo and drag the files within the Sources folder into your project.

When initializing the Tealium SDK, update the completion handler as follows:

tealium = Tealium(config: config) { responses in
guard let remoteCommands = self.tealium?.remoteCommands() else {
  return
}
let brazeTracker = BrazeTracker()
let brazeCommand = BrazeCommand(brazeTracker: brazeTracker)
let brazeRemoteCommand = brazeCommand.remoteCommand()
remoteCommands.add(brazeRemoteCommand)
}

Add the remote command for Swift or Objective-C:

Add the remote command in the TealiumHelper.swift file as follows:

let brazeTracker = BrazeTracker()
let brazeCommand = BrazeCommand(brazeTracker: brazeTracker)
let brazeRemoteCommand = brazeCommand.remoteCommand()
tealium.addRemoteCommandID("braze",
                           description: nil,
                           targetQueue: DispatchQueue.main,
                           responseBlock: brazeRemoteCommand)

Import the remote command in the TealiumHelper.m file as follows:

#import "TealiumRemoteCommandObjcApp-Swift.h"

The Swift bridging header for your target is named ending with -Swift.h. Find this by filtering for “Module Name” in your target’s build settings.

Learn more in the Apple Developer Documentation: Importing Swift Into Objective-C.

Initialize the remote command as follows:

BrazeTracker *brazeTracker = [[BrazeTracker alloc] init];
BrazeCommand *brazeCommand = [[BrazeCommand alloc] initWithBrazeTracker:brazeTracker];
TEALRemoteCommandResponseBlock brazeRemoteCommand = [brazeCommand remoteCommand];
[[Tealium instanceForKey:@"MY_INSTANCE"] addRemoteCommandID:@"braze"
                                    description:@"Braze Remote Command"
                                    targetQueue:dispatch_get_main_queue()
                                    responseBlock:brazeRemoteCommand];

Initialize

For all Tealium libraries, you need to register the Braze remote command when you initialize.

The following code is designed for use with Tealium’s Android library:

import com.tealium.remotecommands.BrazeRemoteCommand;

Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);

BrazeRemoteCommand braze;
// Initialize with default configuration options.
braze = new BrazeRemoteCommand(config);

// Or alternatively initialize with some additional config options:
Set<Class> sessionHandlingBlacklist = new HashSet<>();
Set<Class> inAppMessageBlacklist = new HashSet<>();
// sessionHandlingBlacklist.add(MainActivity.class);
// inAppMessageBlacklist.add(UserActivity.class);
braze = new BrazeRemoteCommand(config,
        true,                     // sessiongHandlingEnabled
        sessionHandlingBlacklist, // sessionHandlingBlacklist
        true,                     // registerInAppMessageManager
        inAppMessageBlacklist);   // inAppMessageBlackList

// Optional: Set config options that may not be supported yet by the Tag in Tealium IQ
//              or simply to override settings locally.
braze.registerConfigOverride(new BrazeRemoteCommand.ConfigOverrider() {
    @Override
    public void onOverride(AppboyConfig.Builder b) {
        b.setPushDeepLinkBackStackActivityEnabled(true);
        b.setPushDeepLinkBackStackActivityClass(UserActivity.class);
    }
});

// register the command
teal.addRemoteCommand(braze);

The following code is designed for use with Tealium’s Objective-C library for iOS, although it is written in Swift. A Bridging Header is required in your Xcode project for this code to work correctly.

let config = TEALConfiguration(account: "ACCOUNT",
                               profile: "PROFILE",
                               environment: "ENVIRONMENT",
                               datasource: "DATASOURCE")
let teal = Tealium.newInstance(forKey: "teal", configuration: config)

let brazeTracker = BrazeTracker()
let brazeCommand = BrazeCommand(brazeTracker: brazeTracker)
let brazeRemoteCommand = brazeCommand.remoteCommand()
teal.addRemoteCommandID("braze", description: nil, targetQueue: DispatchQueue.main, responseBlock: brazeRemoteCommand)

The following code is designed for use with Tealium’s Swift library for iOS:

var teal : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           datasource: "DATASOURCE",
                           optionalData: nil)

teal = Tealium(config: config) { responses in
  guard let remoteCommands = self.tealium?.remoteCommands() else {
        return
  }
  let brazeTracker = BrazeTracker()
  let brazeCommand = BrazeCommand(brazeTracker: brazeTracker)
  let brazeRemoteCommand = brazeCommand.remoteCommand()
  remoteCommands.add(brazeRemoteCommand)
}

Supported Methods

The following Braze methods are triggered using a data mapping in the Braze Remote Command tag using the following Tealium commands:

Remote Command	Braze Method
`appendcustomarrayattribute`	`addToCustomAttributeArrayWithKey()`
`emailnotification`	`setEmailNotificationSubscriptionType()`
`facebookuser`	`facebookUser()`
`incrementcustomattribute`	`incrementCustomUserAttribute()`
`initialize`	`startWithApiKey()`
`logcustomevent`	`logCustomEvent()`
`logpurchase`	`logPurchase()`
`pushnotification`	`setPushNotificationSubscriptionType()`
`removecustomarrayattribute`	`removeFromCustomAttributeArrayWithKey()`
`setcustomattribute`	`setCustomAttributeWithKey()`
`setcustomarrayattribute`	`setCustomAttributeArrayWithKey()`
`setlastknownlocation`	`setLastKnownLocationWithLatitude()`
`twitteruser`	`twitterUser()`
`unsetcustomattribute`	`unsetCustomAttributeWithKey()`
`useralias`	`addAlias()`
`userattribute`	`ABKUser()`
`useridentifier`	`changeUser()`

Since the Braze SDK is installed alongside the Tealium SDK, trigger any native Braze functionality given the corresponding tag configuration.

SDK Setup

Initialize

The Braze SDK is initialized automatically upon launch. The Braze API key is set in the tag configuration.

Remote Command	Braze Method (iOS)	Braze Method (Android)
`initialize`	`startWithApiKey()`	`configure()`

The following mappings are used to set launch options.

Parameter	Type	Description
`custom_endpoint`	`String`	Sets a custom API endpoint. This gets sent in the format `sdk.api.braze.eu`
`device_options`	`Int`	Key to specify a whitelist for device fields that are collected by the Braze SDK (default all fields are collected)
`disable_location`	`Int`	Disable automatic location data collection (`1` or `0`)
`enable_geofences`	`Int`	Enable automatic collection of geofences (`1` or `0`)
`flush_interval`	`Double`	Sets the data flush interval (in seconds). Values are converted into NSTimeIntervals and must be greater than `1.0`
`push_story_identifier`	`String`	This key is set to a string value representing the app group name for the Push Story Notification Content extension.
`request_processing_policy`	`Int`	Possible values for the SDKs request processing (default ABKAutomaticRequestProcessing)
`session_timeout`	`Int` (seconds)	The session timeout in seconds (default: `30` seconds)
`trigger_interval_seconds`	`Int` (seconds)	Override the minimum interval between in-app message triggers (default: `30` seconds)

Android

Braze Developer Guide: Initial SDK Setup

iOS

User Tracking

Assigning a User ID

Remote Command	Braze Method
`useridentifier`	`changeUser`

Parameter	Type
`user_id` (required)	`String`

Braze Developer Guide: Analytics User IDs
- iOS
- Android

Aliasing Users

Remote Command	Braze Method
`useralias`	`addAlias`

Parameter	Type
`user_alias` (required)	`String`
`alias_label` (required)	`String`

Braze Developer Guide: Analytics Alias Users
- iOS
- Android

User Attributes

Standard Attributes

Event	Braze Method
userattribute	Set fields on the `ABKUser/AppboyUser` object

Parameter	Type
`first_name`	`String`
`last_name`	`String`
`email`	`String`
`date_of_birth`	`String`
`country`	`String`
`language`	`String`
`home_city`	`String`
`phone`	`String`
`avatar_image_url`	`String`
`gender`	`String`

Braze Developer Guide: Analytics User Attributes
- iOS
- Android
Braze Developer Guide: User Data API

Set Custom Attribute

Remote Command	Braze Method (iOS)	Braze Method (Android)
`setcustomattribute`	`setCustomAttributeWithKey`	`setCustomUserAttribute`

Parameter	Type
`set_custom_attribute.PROPERTY`	`[String: Any]` / `JSONObject`

Braze Developer Guide: Analytics Custom Attributes
- iOS
- Android

Unset Custom Attribute

Remote Command	Braze Method (iOS)	Braze Method (Android)
`setcustomattribute`	`unsetCustomAttributeWithKey`	`unsetCustomUserAttribute`

Parameter	Type
`set_custom_attribute.PROPERTY`	`String`

Braze Developer Guide: Analytics Custom Attributes
- iOS
- Android

Increment Custom Attribute

Remote Command	Braze Method
`incrementcustomattribute`	`incrementCustomUserAttribute`

Parameter	Type
`increment_custom_attribute.PROPERTY`	`String`

Braze Developer Guide: Analytics Incrementing Attributes
- iOS
- Android

Set Custom Array Attribute

Remote Command	Braze Method (iOS)	Braze Method (Android)
setcustomarrayattribute	`setCustomAttributeArrayWithKey`	`setCustomAttributeArray`

Parameter	Type
`set_custom_array_attribute.PROPERTY`	`[String: [Any]]` / `JSONObject`

Braze Developer Guide: Analytics Array Attributes
- iOS
- Android

Append Custom Array Attribute

Remote Command	Braze Method (iOS)	Braze Method (Android)
`appendcustomarrayattribute`	`addToCustomAttributeArrayWithKey`	`addToCustomAttributeArray`

Parameter	Type
`append_custom_array_attribute.PROPERTY`	`[String: String]` / `JSONObject`

Braze Developer Guide: Analytics Array Attributes
- iOS
- Android

Remove Custom Array Attribute

Remote Command	Braze Method (iOS)	Braze Method (Android)
removecustomarrayattribute	`removeFromCustomAttributeArrayWithKey`	`removeFromCustomAttributeArray`

Parameter	Type
`remove_custom_array_attribute.PROPERTY`	`[String: String]` / `JSONObject`

Braze Developer Guide: Analytics Array Attributes
- iOS
- Android

Facebook

Remote Command	Braze Method
`facebookuser`	Initialize an `ABKFacebookUser/FacebookUser` object

Parameter	Type
`facebook_id`	`[String: Any]` / `String`
`friends_count`	`Int`
`likes`	`[Any]` / `String[]`

Braze Developer Guide: Social Data
- iOS
- Android

Twitter

Remote Command	Braze Method
`twitteruser`	Initialize a `ABKTwitterUser/TwitterUser` object

Parameter	Type
`description`	`String`
`twitter_name`	`String`
`profile_image_url`	`String`
`screen_name`	`String`
`followers_count`	`Int`
`friends_count`	`Int`
`statuses_count`	`Int`
`twitter_id`	`Int`

Braze Developer Guide: Social Data
- iOS
- Android

Custom Event Tracking

Custom Event

Remote Command	Braze Method
`logcustomevent`	`logCustomEvent`

Parameter	Type
`event_name` (required)	`String`
`event_properties`	`[String: Any]` / `JSONObject`

Braze Developer Guide: Analytics Custom Events
- iOS
- Android

Notifications

Email Notifications

Remote Command	Braze Method
`emailnotification`	`setEmailNotificationSubscriptionType`

Parameter	Type	Example
`email_notification`	`String`	[`"optedin"`, `"subscribed"`, `"unsubscribed"`]

Braze Developer Guide: Analytics Email Subscriptions
- iOS
- Android

Push Notifications

Remote Command	Braze Method
pushnotification	`setPushNotificationSubscriptionType`

Parameter	Type	Example
`push_notification`	`String`	[`"optedin"`, `"subscribed"`, `"unsubscribed"`]

Braze Developer Guide: Analytics Push Notifications
- iOS
- Android

Purchase Tracking

Log Purchase

Remote Command	Braze Method
logpurchase	`logPurchase`

Parameter	Type
`product_id` (required)	`[String]` / `String[]`
`currency` (required)	`String` / `String`
`price` (required)	`[Double]` / `Double[]`
`quantity`	`[Int]` / `Int[]`
`purchase_properties`	`[AnyHashable: Any]` / `JSONObject`

Braze Developer Guide: Analytics Purchase Events
- iOS
- Android

Location Tracking

Set User’s Last Known Location

Remote Command	Braze Method
`setlastknownlocation`	`setLastKnownLocationWithLatitude`

Parameter	Type
`latitude` (required)	`Double`
`longitude` (required)	`Double`
`horizontalAccuracy` (required)	`Double`
`altitude`	`Double`
`verticalAccuracy`	`Double`

Braze Developer Guide: Analytics Location Tracking

Data Privacy

Enable SDK

Remote Command	Braze Method (iOS)	Braze Method (Android)
`enable_sdk`	`enableSDK`	`enableSdk/disableSdk`

Parameter	Type	Example
`enable_sdk`	`Boolean`	`true / false`

Braze Developer Guide: Analytics Disabling
- iOS
- Android

Wipe Data

Remote Command	Braze Method
`wipe_data`	`wipeData`

Braze Developer Guide: Analytics Disabling
- iOS
- Android

Requirements

How It Works

Install

Dependency Manager

Manual (iOS)

Initialize

Supported Methods

SDK Setup

Initialize

User Tracking

Assigning a User ID

Aliasing Users

User Attributes

Standard Attributes

Set Custom Attribute

Unset Custom Attribute

Increment Custom Attribute

Set Custom Array Attribute

Append Custom Array Attribute

Remove Custom Array Attribute

Social Data Tracking

Facebook

Twitter

Custom Event Tracking

Custom Event

Notifications

Email Notifications

Push Notifications

Purchase Tracking

Log Purchase

Location Tracking

Set User’s Last Known Location

Data Privacy

Enable SDK

Wipe Data