Braze Setup Guide

The way Fivetran connects Braze to your destination depends on the cloud file storage service you use. Follow the setup instructions for your storage service.

Prerequisiteslink

To connect your Braze account to Fivetran, you need:

• A Braze account with active subscription and admin privileges
• A Braze Current connected to Google Cloud Storage, Amazon S3, or Microsoft Azure Blob Storage
• Braze API URL
• Braze API key
• A Fivetran account with Account Administrator privileges

Google Cloud Storage Setup Instructionslink

Find Fivetran emaillink

1. In the Cloud Storage section of the connector setup form, select Google Cloud Storage.

2. Make a note of the email address. You will need it to grant Fivetran access to your Google Cloud Storage bucket.

   

Create API keylink

1. Log in to your Braze dashboard at https://dashboard.braze.com or your designated dashboard URL. See Braze’s endpoints documentation for a complete list of URLs.

2. In the bottom left corner of your Braze dashboard, click Developer Console.

   

3. Follow Braze’s API key guide to create an API key for Fivetran. Enable the following permissions for the API key:

   • users.export.ids
   • users.export.segment
   • email.unsubscribe
   • email.hard_bounces
   • messages.schedule_broadcasts
   • campaigns.list
   • campaigns.details
   • canvas.list
   • canvas.details
   • segments.list
   • segments.details
   • purchases.product_list
   • events.list
   • feed.list
   • feed.details
   • templates.email.info
   • templates.email.list
   • subscription.status.get
   • subscription.groups.get

4. Make a note of the API key. You will need it to configure Fivetran.

Grant bucket accesslink

1. Go to your Google Cloud Storage console.

2. Find the bucket that you configured the Braze Current with. Click Edit bucket permissions.

   

3. Grant Storage Object Viewer access to the Fivetran email address you found in Step 1.

   

4. Make a note of your bucket name. You will need it to configure Fivetran.

   

Finish Fivetran configurationlink

1. In the connector setup form, enter the Destination schema name of your choice.

2. Enter the API URL and API Key you created in Step 2.

3. Enter the Bucket Name that you found in Step 3. You can also find the Bucket name in your Braze dashboard (Go to Integration > Current > your-current-name > Bucket Name).

4. Enter the Folder name. You can find the folder name in your Braze dashboard (Go to Integration > Current > your-current-name > Prefix).

5. Click Save & Test. Fivetran will take it from here and sync your data from your Braze account.

Amazon S3 Setup Instructionslink

Find External ID link

1. In the Cloud Storage section of the connector setup form, select Amazon S3.

2. Make a note of the External ID. You will need it to allow Fivetran access to your S3 bucket.

   

Create API keylink

1. Log in to your dashboard at https://dashboard.braze.com or your designated dashboard URL. See Braze’s endpoints documentation for a complete list of URLs.

2. In the bottom left corner of your Braze dashboard, click Developer Console.

   

3. Follow Braze’s API key guide to create an API key for Fivetran. Enable the following permissions for the API key:

   • users.export.ids
   • users.export.segment
   • email.unsubscribe
   • email.hard_bounces
   • messages.schedule_broadcasts
   • campaigns.list
   • campaigns.details
   • canvas.list
   • canvas.details
   • segments.list
   • segments.details
   • purchases.product_list
   • events.list
   • feed.list
   • feed.details
   • templates.email.info
   • templates.email.list
   • subscription.status.get
   • subscription.groups.get

4. Make a note of the API key. You will need it to configure Fivetran.

Create an IAM Policylink

1. Open the Amazon IAM console.

2. Click Policies, then Create Policy.

   

3. Click the JSON tab.

   

4. Copy the following policy, replacing {your-bucket-name} with the name of your S3 bucket.

   {
   "Version": "2012-10-17",
   "Statement": [
       {
         "Effect": "Allow",
         "Action": [
   "s3:Get*",
   "s3:List*"
         ],
         "Resource": "arn:aws:s3:::{your-bucket-name}/*"
       },
       {
         "Effect": "Allow",
         "Action": [
   "s3:Get*",
   "s3:List*"
         ],
         "Resource": "arn:aws:s3:::{your-bucket-name}"
       }
     ]
   }
   

5. Click Review Policy.

   

6. Name the policy something memorable (for example, “Fivetran-S3-Access”).

   

7. Click Create Policy.

Create an IAM Rolelink

1. Click Roles, then Create New Role.

   

2. Select Another AWS Account, then enter Fivetran’s account ID, 834469178297, in the Account ID field.

   

3. Click the check box for the Require external ID option.

4. Enter the external ID you found in Step 1.

   

5. Click Next: Permissions.

6. Select the policy that you created earlier (for example, “Fivetran-S3-Access”).

   

7. Click Next: Review.

8. Name your new role (for example, “Fivetran”).

   

9. Click Create Role.

10. Click the role you just created.

    

11. Find the Role ARN and make a note of it. You will need it to configure Fivetran.

    

Set Permissions (Optional)link

You can specify permissions for the Role ARN that you designate for Fivetran. Giving selective permissions to this Role only allows Fivetran to sync what it has permissions to see.

Enable User Profile Exports (Optional)link

To sync the USER and USER_ALIAS tables, you must use the Enable User Profile Exports toggle in the connector setup form. You can choose either:

• Amazon S3: You must provide an S3 bucket to which Braze will write the User export files.
• No Export Storage: Braze will use their S3 storage and provide Fivetran with a link to the export files.

We recommend that you configure your own S3 bucket. You can either:

• Use the same S3 bucket you used for the Currents
• Use a different S3 bucket

To use your S3 bucket, do the following:

1. Log in to the Braze dashboard.

2. In the left menu, click Technology Partners.

3. On the Technology Partners page, select Amazon S3 Cloud Storage.

   

4. In the Data Export using AWS Credentials section, make a note of the Role ARN, AWS S3 Bucket Name, and AWS S3 Bucket Folder details. You will need them to configure Fivetran.

   

Finish Fivetran configurationlink

1. In the connector setup form, enter the Destination schema name of your choice.

2. Enter the API URL and API Key you created in Step 2.

3. Enter the Bucket name from the Braze dashboard (Go to Integration > Current > your-current-name > Bucket Name).

4. Enter the Role ARN you found in Step 4.

5. Enter the Folder name. You can find the folder name in your Braze dashboard (Go to Integration > Current > your-current-name > Prefix).

6. (Optional) Set the Enable User Profile Exports toggle to Enabled, and then choose your Export Storage. If you select Amazon S3, enter the details you found in Step 6.

7. Click Save & Test. Fivetran will take it from here and sync your data from your Braze account.

Microsoft Azure Blob Storage Setup Instructionslink

Select Azure Blob Storagelink

In the Cloud Storage section of the connector setup form, select Azure Blob Storage.

Create API keylink

1. Log in to your Braze dashboard at https://dashboard.braze.com or your designated dashboard URL. See Braze’s endpoints documentation for a complete list of URLs.

2. In the bottom left corner of your Braze dashboard, click Developer Console.

   

3. Follow Braze’s API key guide to create an API key for Fivetran. Enable the following permissions for the API key:

   • users.export.ids
   • users.export.segment
   • email.unsubscribe
   • email.hard_bounces
   • messages.schedule_broadcasts
   • campaigns.list
   • campaigns.details
   • canvas.list
   • canvas.details
   • segments.list
   • segments.details
   • purchases.product_list
   • events.list
   • feed.list
   • feed.details
   • templates.email.info
   • templates.email.list
   • subscription.status.get
   • subscription.groups.get

4. Make a note of the API key. You will need it to configure Fivetran.

Find connection stringlink

1. In the Microsoft Azure console, go to your storage account.

2. On the left navigation pane, select Access keys and then click Show Keys.

   

3. Find the Connection string and make a note of it. You will need it to configure Fivetran.

   

Grant container accesslink

1. In the Microsoft Azure console, go to your storage account.

2. Select Containers. Select the container that you configured the Braze Current with. Click Change access level.

   

3. In the Public access level dropdown menu, select Container (anonymous read access for containers and blobs) and then click OK.

   

Finish Fivetran configurationlink

1. In the connector setup form, enter the Destination schema name of your choice.

2. Enter the API URL and API Key you created in Step 2.

3. Enter the Connection String that you found in Step 3.

4. Enter the Container Name that you configured in Step 4. You can also find the Container name in your Braze dashboard (Go to Integration > Current > your-current-name > Container Name).

5. Enter the Prefix. You can find the prefix in your Braze dashboard (Go to Integration > Current > your-current-name > Prefix).

6. Click Save & Test. Fivetran will take it from here and sync your data from your Braze account.

Related Contentlink

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connector Configuration

home Documentation Home