Get Started

OverviewCreate a sourceCreate a modelCreate a destinationCreate a sync


Table of Contents
Braze is a comprehensive customer engagement platform that powers relevant and memorable experiences between consumers and the brands they love.


To find the region code, use the table provided below to find the region of your REST / SDK endpoints.
Note: You can also navigate to the Braze documentation to view any additional Regions they may add. In their table, they refer to this region as "REST ENDPOINT", you would just need to remove the prefix starting with https://rest. To find the API key, navigate to Developer Console > API Settings and create a API key.

Syncing Braze Objects

Hightouch supports syncing to the following Braze objects:
  • Users
  • Events

Sync Modes

This integration supports both the Upsert and Update mode.In the Upsert mode, new users will be inserted into Braze and all attributes will be kept up-to-date within Braze.In the Update mode, Hightouch will update attributes on users that already exist in Braze.

Record Matching

Records can be matched from your source to your Braze workspace by your Braze External User ID in the Upsert mode. In the Update mode, Hightouch also allows you to match records based on Braze ID or a user alias object.

Field Mapping

You can sync columns from your source to Braze's default and custom fields. If a custom field is sent that does not exist, it will be added and its type will be automatically detected.You can manage your custom fields in Manage App Group > Custom Attributes.

Column-based Diffing

Braze pricing is based on data points, which will count the number of updates you (and Hightouch) makes to user properties. With this in mind:
  • For records that enter the query results, Hightouch will update all the mapped properties with the value from your query results.
  • For records that are already in the query results, but are changed, Hightouch will first get the user properties from Braze, calculate which columns actually changed, then only send the changes for those columns.

Syncing Braze Events

Hightouch supports syncing events to Braze and assigning them to a user.

Event Types

There are two types of events that can be sent to the destination
  • Track Event: Sends events of a particular name when a record is added
  • Track Purchase: Track when a customer makes a purchase

Creating Users with Events

Hightouch allows you to choose whether to create users that don't exist. For example, if you are tracking an event associated to user A, if user A does not exist in Braze, we can either choose to create the user, or ignore the event.

Track Configuration

Hightouch allows you to choose the event name, user ID and event timestamp for a track event. Tracking purchases does not require an event name. If you are creating users that don't exist, you can only match based on external ID, otherwise you can match based on Braze ID and user alias object.Note: Hightouch accepts a normal date time format for the timestamp, and automatically convert it to the format that Braze requires.

Field Mappings

Hightouch allows you to pass data to the event properties of a Braze event.