Braze Integration

Overview

Heap’s Braze integration allows you to incorporate user behavior data from Heap into marketing campaigns without additional engineering effort. Campaigns can be more effectively personalized to better drive critical product and business outcomes, like activation, trial conversion, and retention.

Source (data in)

Step 1: Configure the integration in Heap

1. Navigate to Integrations > Directory and search for Braze
2. Click the Set up button in the Data In panel
3. Fill in the identity keys and prefixes. You have two choices for each identity key:
   • Braze identity: external_user_id or user_id
   • Heap identity: identity or user_id
   • Braze event & property prefix: use “braze-”, or whichever prefix you prefer

Step 2: Configure the Braze Current

If you previously set up this integration with our partner Sureshot, you will need to edit the existing Current and change the endpoint. 

1. In Braze, navigate to Partner Integrations > Currents
2. If you're editing an existing Current, click the pencil icon next to your Heap Current and then Edit Current. If this is your first time making a Current, click Create new Current instead. 
3. Replace YOUR_ID_HERE in the following URL with your Heap environment ID, and paste the whole URL into the Endpoint field: https://heapanalytics.com/api/integrations/braze?env_id=YOUR_ID_HERE 
   • You can find your Heap env ID in your address bar when you're logged into Heap. In the following example, the env ID is 0123456789: https://heapanalytics.com/app/env/0123456789/overview/usage-baselines
   • An alternate way to find your env ID is to navigate to Account > Manage > Projects and click on the project associated with the environment you want the ID for
4. Click Update Current to save your changes

Destination (data out)

Step 1: Collect your API credentials from your Braze account

Before you can send data from Heap to Braze, you’ll need to collect the following information from your Braze account:

1. Endpoint
2. Data Import Key (aka Secret)
3. API key, with appropriate permissions

Endpoint and Data Import key (aka Secret) can be found under Integrations > Technology Partners > search for Heap.

Once Heap is selected, the Cohort Key (secret) and Endpoint will be displayed. If one does not exist, click the Generate New Key button to create one. Note that this will replace any previous key if one already exists.

The API Key can be found in Braze under Settings > APIs & Identifiers > API Keys (copy the Identifier).

It’s a requirement that the proper permissions for this API Key are applied. Please ensure the following permissions are checked:

Step 2: Enable Braze destination in Heap

In Heap, go to Integrations > Directory and search for Braze.

In the Data Out panel, click Set up and fill in the fields with the credentials you collected in Step 1:

Click Confirm and the integration is now set up!

Step 3: Sync Heap Segments to Braze

Now you can toggle on any defined segment to sync into Braze as Cohorts. 

1. In Heap, navigate to Data > Segments
2. Click on the desired segment
3. Within the Integrations section of the pop-up, click the toggle next to Braze.

The first time you sync a segment from Heap to Braze, you’ll be asked to select which field from Heap should be sent to Braze. This can be things like identity, email, or various Heap user properties. Click Confirm to save your choices. 

Once mapped, you can begin syncing segments to Braze. You can choose to Sync Now or set Recurring Sync to continually sync the Segment to Braze.

The segment will begin syncing immediately, and you should see a Cohort in Braze with the same segment name within 2-5 minutes. We only allow you to have 30 segments recurrently syncing to Braze at one time. After the first sync completes, the segment will update every 4 hours.

Once synced to Braze, a Cohort is created in Braze using the same name as the Heap Segment.  All users that belong to the Heap Segment will be added to the Braze Cohort.  If users are removed from the Heap segment due to the Heap segment criteria, they will be removed from the Braze Cohort during the next sync.

Creating Segment in Braze using the new Cohort

Syncing Heap segments to Braze creates a Cohort in Braze.  All users in the Heap segment will be in the Braze Cohort, and as users are added to or removed from the Heap segment, the Braze cohort will be updated (assuming that Recurring Sync was selected on the Heap segment).

Step 1: Create Segment in Braze

In Braze, navigate to Segments and click the Create Segment button. Provide a Segment name and optionally a description.

Step 2: Add the filter to the segment that uses the new Cohort

To pull up the details for any Segment in Braze, click on it from the Segments page. From the details page, under the Filters section, search for Heap Cohort.

Next, search for a Cohort value. Because the Cohort will be created with the same name as the Heap segment, search for the Heap segment name here. You can also add any additional filter criteria that you’d like to complete the Braze Segment.