Analytics Swift Braze Plugin

Braze, formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.

Braze’s destination plugin code is open source and available on GitHub. You can view it on GitHub in the @braze-inc/analytics-swift-braze repo. This destination plugin is maintained by Braze. For any issues with the destination plugin code, please reach out to Braze’s support.

Getting Started

1. From the Segment web app, click Catalog.
2. Search for “Braze” in the Catalog, select it, and choose which of your sources to connect the destination to.
3. In the Destination Settings, add the API Key, found in the Braze Dashboard in App Settings > Manage App Group.
4. Set up a new App Group REST API Key in the Braze Dashboard in App Settings > Developer Console > API Settings. For more information, see Creating and Managing REST API Keys in the Braze documentation.
   • Select the users.track endpoint in the User Data section.

Adding the dependency

Through Xcode

In the Xcode File menu, click Add Packages. You’ll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repository.

https://github.com/segment-integrations/analytics-swift-braze

You’ll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you’ve made your selections, click the Add Package button.

Through Package.swift

Open your Package.swift file and add the following to the dependencies section:

.package(
            name: "Segment",
            url: "https://github.com/segment-integrations/analytics-swift-braze.git",
            from: "1.0.0"
        ),

Using the Plugin in your App

Open the file where you setup and configure the Analytics-Swift library. Add this plugin to the list of imports.

import Segment
import SegmentBraze // <-- Add this line

Just under your Analytics-Swift library setup, call analytics.add(plugin: ...) to add an instance of the plugin to the Analytics timeline.

let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
                    .flushAt(3)
                    .trackApplicationLifecycleEvents(true))
analytics.add(plugin: BrazeDestination())

Identify

If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

struct MyTraits: Codable {
        let favoriteColor: String
}

analytics.identify(userId: "a user's id", MyTraits(favoriteColor: "fuscia"))

When you Identify a user, Segment passes that user’s information to Braze with userId as Braze’s External User ID.

If you’re using a device-mode connection, Braze’s SDK assigns a device_id and a backend identifier, braze_id, to every user. This allows Braze to capture anonymous activity from the device by matching on those identifiers instead of userId. This applies to device-mode connections.

Capture the braze_id of anonymous users

Pass one of the many identifiers that may exist on an anonymous user profile to the Braze’s User by Identifier REST endpoint to capture and export the braze_id. These identifiers include:

• email address
• phone number
• device_id

Choose an identifier that is available on the user profile at that point in the user lifecycle.

For example, if you pass device_id to the User by Identifier endpoint:

{
  "device_id": “",
  "fields_to_export": ["braze_id"]
}

The endpoint returns:

{
  "users": [
    {
        "braze_id": “"
    }
  ],
  "message": "success"
} 

Segment’s special traits recognized as Braze’s standard user profile fields (in parentheses) are:

Segment sends all other traits (except Braze’s reserved user profile fields) to Braze as custom attributes. You can send an array of strings as trait values but not nested objects.

Track

The Braze Swift destination plugin currently only supports sending logPurchase events, and custom events are not supported in device mode. Please review the plugin code for more information.

Braze supports currency codes as specified in their Purchase Object Specification. Be aware that any currency reported other than USD displays in the Braze UI in USD based on the exchange rate on the date it was reported.