Braze

📘
DataGuard Support sets up this integration for you
This guide shows you what to prepare in Braze and which details to send to DataGuard Support.

Braze is a customer engagement platform for email, SMS, push and in-app messaging. The Braze integration sends consent data one way, from DataGuard CPM to Braze, so your Braze users always have the latest consent and preference information.

Permissions are synced to Braze subscription groups.
Preferences are synced to Braze custom attributes.
Braze users are matched by External User ID, which is the citizen's external reference in DataGuard CPM.

Prerequisites

Access to the DataGuard CPM Platform.
Administrative access to your Braze account.

If you don't have access to the DataGuard CPM Platform, please contact us.

Prepare your Braze account

Step 1: Create an API key

Log in to your Braze account.
Go to Settings and open API Keys.
Click + Create New API Key.
Give the key the users.track permission. The integration doesn't need any other permissions.
Save the key. You will need it when DataGuard Support sets up the integration.

Step 2: Find your REST endpoint

Your REST endpoint depends on the Braze instance your account is on. It matches the address of your Braze dashboard. For example, if you log in at dashboard-01.braze.eu, your REST endpoint is https://rest.fra-01.braze.eu.

For the full list, see API endpoints in the Braze documentation.

Step 3: Create email subscription groups

In Braze, go to Audience > Subscriptions.
Click + Create Email Subscription Group.
Enter a name and description, and save.
Copy the Subscription Group ID. You will map each subscription group to a consent option in DataGuard CPM.

Repeat for each consent option you want to sync.

What to send DataGuard Support

Detail	Example / notes
Your CPM Application ID	Found on the Credentials page of the DataGuard CPM UI.
Braze REST endpoint	`https://rest.fra-01.braze.eu`
Braze API key	The key you created in Step 1.
Consent option → subscription group mapping	For each consent option you want to sync, the Braze Subscription Group ID it should update. You can give us the consent purpose and option names. Support will look up the IDs.
Sync existing citizens?	Yes or no. If yes, citizens already in CPM are sent to Braze when the integration is created. Choose yes if you use In-App Campaigns for existing users (see below).

How to contact DataGuard Support

Check the data in Braze

Once Support confirms the integration is active:

In Braze, go to Audience > Search Users and search by External User ID, using the citizen's external reference from DataGuard CPM.
Permissions are under the user's Engagement tab, in Contact Settings.
Preferences are under the user's Overview tab, in Custom Attributes.

In-App Campaigns

You can embed DataGuard CPM widgets in Braze In-App Campaigns to collect consent directly. The integration stores each user's DataGuard CPM access token in the custom attribute dg_access_token, which the In-App Campaign uses to show the user's current consent. The token is renewed automatically before it expires.

If you chose not to sync existing citizens, those users only get a token after their next consent change. Until then, the Existing User option won't work for them.

See the Braze In-App Campaigns guide.

Changing the integration

To rotate your API key, change the subscription group mapping or pause the integration, contact DataGuard Support with the details you want to change.