Skip to main content

Integrating Braze

Capabilities

DataGrail's Braze integration provides the following capabilities:

ProductCapability
Request Manager
Request TypesAccess, Deletion, Do Not Sell/Share
Identifier CategoriesEmail
Live Data MapSystem 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

  1. Log in to the Braze dashboard.
  2. In the left panel, select Developer Console and then API Settings.
  3. Select Create New API Key.
  4. 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
  1. Select Save API Key.
  2. Once redirected, copy and securely store the newly created API Key from the REST API Keys table.
  3. 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 is US-03.

Connect to DataGrail

  1. Navigate back to DataGrail.
  2. Enter your API Key and select your Instance.
  3. 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.

  1. 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.
  2. Using the credentials created above, add a new integration in DataGrail for your cloud storage provider.
  3. Set the Integration Name to Braze Exports.

Next Steps

Now that you've successfully connected the integration, check out the following resources:

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 TypeSynchronous
Deletion TypeAsynchronous

API Documentation

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.

 

Need help?
If you have any questions, please reach out to your dedicated CSM or contact us at support@datagrail.io.

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.