Braze (Cohort Sync)

Amplitude Data's Braze integration sends your Amplitude cohorts to Braze with a few clicks.

Considerations

• Enable this integration in each Amplitude project where you want to use it.
• For more details on using this integration in Braze, refer to the Braze documentation.
• You need a Braze account.
• After Braze identifies a user, Amplitude must refer to them by their external_id instead of their device_id due to Braze requirements. Amplitude recommends setting up two syncs to the destination for each cohort to address this limitation: one sync mapping device_id and one sync mapping user_id. With both syncs, Amplitude attempts to add or remove users through their external_id, if it exists, as well as their device_id.

Prerequisites

To configure a cohort integration from Amplitude to Braze, you need the following information from Braze:

1. Data Import Key (Braze REST API key)

   • In Braze, click Partner Integrations then click Amplitude and Generate New Key. The Data Import Key is the Braze REST API key mentioned in the Braze documentation.
   • Refer to the Braze documentation for more detail.

2. Endpoint: the endpoint for the REST operations

   • In Braze, click Partner Integrations and click Amplitude.
   • It looks like: https://rest.iad-##.braze.com.
   • Refer to the Braze documentation to find your endpoint.

Set up the integration

Amplitude setup

1. In Amplitude Data, click Catalog and select the Destinations tab.
2. Select the Cohort type and then click Braze. (Optionally) use the search bar to search for Braze.
3. Click Add Destination.
4. Select your endpoint and paste your Data Import Key.
5. Select the Amplitude and Braze properties to map users to.
   • If you select User alias as the target object, add a User alias label. Otherwise, leave it empty.
6. When finished, click Save.

Send a cohort

To sync your first cohort, follow these steps:

1. In Amplitude, open the cohort you want to sync, then click Sync.
2. Select Braze, then click Next.
3. Choose the account you want to sync to.
4. Choose the sync cadence. Select One-Time Sync, Scheduled Sync, or Real-Time sync. For more information about cohort syncing, refer to Sync to third-party destinations.
5. When finished, save your work.

Set up multiple API key targets

Multi-key support configures multiple Braze API keys for each Amplitude project and directs each cohort sync to a specific target. Use this when your organization manages multiple Braze instances, regions, or accounts from a single Amplitude project.

Add a key

1. In Amplitude Data, go to Catalog > Destinations and select your Braze cohort sync connection.
2. In the destination setup modal, click Add Another Key.
3. Enter a name for the target (for example, "US Production" or "EU Staging").

4. Paste the Braze REST API key and select the REST endpoint for this target.
5. Select the user mapping property for this target:
   • user_id: Maps the Amplitude user ID to the Braze external_id. Use this for identified users.
   • device_id: Maps the Amplitude device ID to the Braze device ID. Use this for anonymous users.
   • User alias: Maps users by a custom alias. If you choose this option, enter a User alias label.
6. Click Save.

Repeat these steps for each additional key you want to add.

Select a target when creating a sync

When you create a new cohort sync, Amplitude asks you to choose which target to send the cohort to. Select the named target that corresponds to the Braze instance you want to reach.

Backward compatibility

If you set up the Braze integration before multi-key support became available, your existing configuration continues to work without any changes. Amplitude assigns your original key a target named "Default" and assigns all existing sync jobs to that target automatically. You can add new targets alongside your original key at any time.

Use the cohort in Braze

1. In Braze, navigate to Audience and click Segments.
2. Click Create Segment and name your segment.
3. Under Add Filter, select Amplitude Cohorts and choose the cohort you created and synced from Amplitude.
4. After saving, you can reference this segment during Canvas or campaign creation in the targeting users step.

Email notifications

Amplitude automatically sends email alerts for cohort sync jobs:

• Success notifications: Amplitude sends a confirmation when your cohort sync to Braze completes successfully.
• Failure notifications: Amplitude alerts you when a sync job fails so you can address any issues promptly.

Troubleshooting

I don't see a list of users in Braze

When you sync a cohort, Braze matches users in that cohort with users that already exist in Braze and doesn't create new users. Ensure users in your Amplitude cohort have a matching user (userId) in Braze.