Braze Integration Guide
Integrating Braze with TrustWorks enables you to automate data subject access and erasure requests, which were previously handled manually. This integration streamlines your data privacy operations, ensuring compliance and reducing the manual effort involved in managing Data Subject Requests (DSRs). This guide will walk you through the setup process, from prerequisites to successful integration.
Prerequisites
Before you begin, ensure you have the following:
- API Key for TrustWorks: This key must have the necessary permissions to manage DSRs.
- API Endpoint: Required to establish a connection between TrustWorks and Braze.
Integration Steps
Create an API Key in Braze:
- Navigate to Braze Settings > APIs and Identifiers > API Keys.
- Select the relevant permissions (
users.export.ids
&users.delete
) that align with the DSRs you plan to automate. - Click on "Create API Key"
Important: Copy this API key as you will need it to connect to TrustWorks.
Locate Your API Endpoint:
- The API endpoint is required for connecting TrustWorks with Braze. Ensure you have this information handy.
The API endpoint is specific to the Braze instance you are using. Braze operates on different clusters (or instances) depending on your region and setup. You'll need to use the correct endpoint for your instance to ensure proper communication between Braze and TrustWorks.
Here’s how to determine your API endpoint:
- US-01:
https://rest.iad-01.braze.com/
- US-02:
https://rest.iad-02.braze.com/
- US-03:
https://rest.iad-03.braze.com/
- US-04:
https://rest.iad-04.braze.com/
- EU-01:
https://rest.fra-01.braze.eu/
- EU-02:
https://rest.fra-02.braze.eu/
- US-05:
https://rest.iad-05.braze.com/
- US-06:
https://rest.iad-06.braze.com/
For example, if your Braze instance is US-03, your API endpoint will be https://rest.iad-03.braze.com/
. Make sure to use the endpoint that matches your Braze instance.
For more info on endpoints please go to https://www.braze.com/docs/api/basics/#endpoints
Set Up the Integration in TrustWorks:
- In TrustWorks, go to Settings > Integrations.
- Click on "Add New" and select "Braze" from the list of available integrations.
- Enter the API key and endpoint you retrieved from Braze.
- Test the connection to ensure everything is set up correctly.
- If the connection is successful, click "Save" to finalize the integration.
Enable Automation for DSRs:
- Navigate to Data Inventory in TrustWorks and locate Braze.
- Click "Edit". (If Braze is not listed, you may need to add it manually to your data map or add it from staging).
- Scroll to the "Details" section, select, and enable the integration.
- Save your changes.
If the integration was successful, Braze automation will now be active in your DSR workflows.
Conclusion
By integrating Braze with TrustWorks, you've automated a crucial part of your data privacy management. This not only enhances your operational efficiency but also strengthens your compliance efforts. If you encounter any issues or have questions, don't hesitate to reach out to our support team.