Braze

This documentation for the Braze integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Braze, visit our connection instructions.

Base URL

The base URL used for all Braze API endpoints contains the Braze Instance:

https:​//dashboard-INSTANCE.braze.com

---

Authentication & Authorization

The DataGrail Braze integration connects using API key authentication which requires a REST API Key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Braze API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Braze integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Access	Deletion	Data Discovery	Opt Out
events.list	✅
users.export.ids	✅		✅
users.delete		✅
users.track				✅
email.unsubscribe			✅
segments.list			✅
users.export.segment			✅

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/email/unsubscribes	Query list of unsubscribed email addresses
POST	/users/export/ids	Export user profile by identifier

---

Limits

Limits in Braze are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Braze integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Export data from the user profile using configured identifiers.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/users/export/ids	Export user profile by identifier

---

Deletion

DataGrail's Braze integration provides Asynchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Export data from the user profile using configured identifiers.
2. Delete selected user profiles using the Braze user identifier.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/users/delete	Delete any user profile by specifying a Braze user identifier
POST	/users/export/ids	Export user profile by identifier

---

Opt Out

DataGrail's Braze integration provides Opt Out capabilities for the following supported identifier category: Email.

Data Interactions

For Opt Out requests, DataGrail will take the following actions:

1. Export data from the user profile using configured identifiers.
2. Update attributes to set opted_out value for all detected user profiles by specifying a Braze user identifier.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/users/export/ids	Export user profile by identifier
POST	/users/track	Track users

---

Data Discovery

DataGrail's Braze integration provides data discovery capabilities based on the principle of finding any and all personal data that's stored in a data system.

Data Interactions

For discovery requests, DataGrail will take the following actions:

1. Retrieve segment IDs and extract user data from the following fields:

Supported Objects

• apps
• braze_id
• country
• custom_attributes
• custom_events
• devices
• dob
• email
• external_id
• first_name
• gender
• home_city
• language
• last_coordinates
• last_name
• phone
• purchases
• time_zone
• total_revenue
• user_aliases

2. Download extracted user data in zip files from AWS S3 or configured Cloud Storage.
3. Get a list of catalogs in a workspace.
4. For each catalog, get item details.
5. Sample data for the next analysis and classification.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/ZIPPED_USER_DATA_PATH	Download extracted user data in zip files from AWS S3 or configured Cloud Storage
GET	/catalogs	Get a list of catalogs in a workspace
GET	/catalogs/CATALOG_NAME/items	List multiple catalog item details
GET	/segments/list	Export segment list
POST	/users/export/segment	Export user profile by segment