Integrating Braze
Capabilities
DataGrail's Braze integration provides the following capabilities:
Product | Capability | ||||
---|---|---|---|---|---|
Request Manager |
| ||||
Live Data Map | System Detection, Data Discovery |
Before You Start
To successfully configure this integration, please ensure you have sufficient privileges:
- DataGrail User Role: Super Admin, Connections Manager
- Braze User Role: Admin
Create a Braze API Key
- Log in to the Braze dashboard.
- In the left panel, select Developer Console and then API Settings.
- Select Create New API Key.
- Enter a name for the API Key and grant DataGrail the necessary permissions for the integration:
Required Permissions
The necessary permissions for Braze vary by the enabled capabilities of the integration.
Access:
users.export.ids
Deletion:
users.delete
Do Not Sell/Share:
users.track
Responsible Data Discovery (RDD):
email.unsubscribe
users.export.segment
segments.list
catalogs.get
catalogs.get_items
- Select Save API Key.
- Once redirected, copy and securely store the newly created API Key from the REST API Keys table.
- Take note of the Braze URL in your browser. This URL will indicate the instance where your account was provisioned. For example,
https://dashboard-03.braze.com/dashboard
means that your instance isUS-03
.
Connect to DataGrail
- Navigate back to DataGrail.
- Enter your API Key and select your Instance.
- Select Configure Integration.
(Optional) Responsible Data Discovery Cloud Storage
For Responsible Data Discovery Connections to Braze accounts with configured cloud storage, the following steps are additionally required.
- Create dedicated credentials with read-only permissions to access your existing Braze export bucket, including the ability to list objects/files. This should be separate from those used to connect for Request Manager purposes.
- Using the credentials created above, add a new integration in DataGrail for your cloud storage provider.
- Set the Integration Name to
Braze Exports
.
Next Steps
Now that you've successfully connected the integration, check out the following resources:
- Synchronous vs. Asynchronous Integrations
- Access Request Lifecycle
- Deletion Request Lifecycle
- Request Manager Overview
Troubleshooting
If you are unable to successfully connect the integration, review these common troubleshooting steps:
Ensure Required Permissions Are Granted on API Keys/Resources
DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.
Review Required Account Types and User Roles
If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.
See Before You Start to review these requirements.
Technical Details
The Braze integration uses the User Data API:Access Type | Synchronous |
---|---|
Deletion Type | Asynchronous |
API Documentation
Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.