Overview

Braze is a customer engagement platform that delivers messaging experiences across push, email, in-app.

Integrating Lytics to Braze helps you import email, SMS, and push activity from Braze and then export Lytics' cross-channel, behavioral-driven audiences to build and send personalized marketing campaigns.

Authorization

If you haven't already done so, you will need to set up a Braze account before you begin the process described below. The Braze credentials necessary to integrate with Lytics are Rest API Key and Braze Instance.
Follow these steps to get your Braze credentials: Create Braze REST API Key. When creating the Braze REST API Key, you must grant permissions for each App Group you would like to use with Lytics.

If you are new to creating authorizations in Lytics, see the Authorizations documentation for more information.

  1. Select Braze from the list of providers.
  2. Select the Braze method for authorization.
  3. In the Label text box, enter a name for the authorization
  4. (optional) In the Description text box, enter a description for this authorization
  5. In the Rest API Key text box, enter your Rest API Key credential.
  6. From the Braze Instance input, select the instance of Braze your account uses (e.g. US-01 or EU-01). See the instructions above if you do not know your Braze instance.
  7. Click Save Authorization.

Import Activity

Connect Braze to Lytics to import email, SMS, and push activity to enrich Lytics user profiles.

Integration Details

  • Implementation Type: Server-side Integration
  • Implementation Technique: File Based Transfer Integration or Webhook Integration.
  • Frequency: Batch Integration or Real-time Integration.
  • Resulting data: User profiles.

Fields

The following fields are included in the default mapping of the braze_users stream:

Source FieldLytics User FieldDescriptionType
emailemail unique idEmail Addressstring
twitter_handletwuser_id unique idTwitter User IDstring
braze_idbr_user_id unique idBraze User IDstring
date_of_birthbirth_dateBirthdaydate
languagebr_languageLanguagestring
phone_numberbr_phone_numberBraze Phone Numberstring
citycityCitystring
countrycountryCountrystring
first_namefirst_nameFirst Namestring
gendergenderGenderstring
last_namelast_nameLast Namestring
time_zonetime_zoneTime Zonestring

Configuration

Braze has three ways to export data to other services:

  • Via Braze's Dashboard, you can export a CSV with up to 500,000 rows. To export a segment with over 500,000 users, you’ll need to use the export API, which places no limit on how much data you can export. You can import CSV files to Lytics via aLytics File Service.

  • Export API allows large dataset to be exported to S3 buckets, which requires your S3 credentials to be added to Braze. More information can be found at Users by Segment Endpoint. This feature is currently not supported by Lytics.

  • Webhooks triggered by events in Braze can be sent to Lytics representing real-time events within campaigns across multiple channels as email, push notification, and more. See Braze's documentation for Creating a Webhook.

    • To create a webhook in Braze you must first create an API token with the Data Manager role as described in our Managing API Tokens documentation.
    • Your webhook URL will contain your Account Number and API Token which can be found in your Account Settings.
     https://api.lytics.io/c/<ACCOUNT-NUMBER>/braze_users?key=<LYTICS-API-TOKEN>
    

The webhook template is expected to include the following fields:

  • city
  • country
  • first_name
  • gender
  • language
  • last_name
  • date_of_birth
  • phone_number
  • time_zone
  • twitter_handle
  • email
  • braze_id

If other fields need to be included, please speak to your Lytics account manager.

Export Audiences

Export cross-channel, behavioral-driven audiences from Lytics to Braze to power personalized marketing campaigns.

Integration Details

  • Implementation Type: Server-side Integration.
  • Implementation Technique: REST API Integration.
  • Frequency: Batch Integration.
  • Resulting data: Lytics audience slugs are added or removed from a user attribute in Braze called lytics_segments.

This integration utilizes the Braze User Track API to attach Lytics audience membership data to Braze as a user attribute. Once the export is started the job will:

  1. As users enter or exit the exported audience in Lytics they are batched.
  2. Once the batch size contains 75 updates or if 5 minutes have elapsed, the batch of updates is sent to Braze through the user track endpoint.

Fields

By default, Lytics exports the following fields to Braze:

Lytics User FieldDescriptionBraze FieldType
Braze User IDBraze User IDexternal_idstring

Configuration

Follow these steps to set up and configure an export job for Braze in the Lytics platform.

  1. Select Braze from the list of providers.
  2. Select the Export Audiences job type from the list.
  3. Select the Authorization you would like to use or create a new one.
  4. Enter a Label to identify this job you are creating in Lytics.
  5. (Optional) Enter a Description for further context on your job.
  6. Select the audiences to export.
  7. From the Braze External User ID Field input, select the field in Lytics that contains the Braze External User ID.
  8. (optional) Select the Existing Users checkbox to add users who already exist in the selected Lytics audience. If unchecked, users will only be exported to Braze on when entering or exiting the audience after the workflow begins.
  9. Click Start Export.
    braze-export-config