Cloud Data Ingestion for Redshift

Product setup

New Cloud Data Ingestion integrations require some setup on the Braze side and in your Redshift instance. Follow these steps to set up the integration:

1. Make sure Braze access is allowed to the Redshift tables you want to sync - Braze will connect to Redshift over the internet.
2. In your Redshift instance, set up the table(s) or view(s) you want to sync to Braze
3. Create a new integration in the Braze dashboard
4. Test the integration and start the sync

Set up tables or views

Step 1: Set up the table

Optionally, set up a new Database and Schema to hold your source table

1
2
CREATE DATABASE BRAZE_CLOUD_PRODUCTION;
CREATE SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION;

Create a table (or view) to use for your CDI integration

1
2
3
4
5
6
7
8
9
10
11
CREATE TABLE BRAZE_CLOUD_PRODUCTION.INGESTION.USERS_ATTRIBUTES_SYNC (
   updated_at timestamptz default sysdate,
   --at least one of external_id, alias_name and alias_label, or braze_id is required
   external_id varchar,
   --if using user alias, both alias_name and alias_label are required
   alias_label varchar,
   alias_name varchar,
   --braze_id can only be used to update existing users created through the Braze SDK
   braze_id varchar,
   payload varchar(max)
)

You can name the database, schema, and table as you’d like, but the column names should match the preceding definition.

• UPDATED_AT - The time this row was updated in or added to the table. We will only sync rows that have been added or updated since the last sync.
• User identifier columns. Your table may contain one or more user identifier columns. Each row should only contain one identifier (either external_id, the combination of alias_name and alias_label, or braze_id. A source table may columns for one, two, or all three identifier types.
  • EXTERNAL_ID - This identifies the user you want to update. This should match the external_id value used in Braze.
  • ALIAS_NAME and ALIAS_LABEL - These two columns create a user alias object. alias_name should be a unique identifier, and alias_label specifies the type of alias. Users may have multiple aliases with different labels but only one alias_name per alias_label.
  • BRAZE_ID - The Braze user identifier. This is generated by the Braze SDK and new users cannot be created using a Braze ID through Cloud Data Ingestion. To create new users, specify an external user ID or user alias.
• PAYLOAD - This is a JSON string of the fields you want to sync to the user in Braze.

Step 2: Create User and grant permissions

1
2
3
CREATE USER braze_user PASSWORD '{password}';
GRANT USAGE ON SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION to braze_user;
GRANT SELECT ON TABLE USERS_ATTRIBUTES_SYNC TO braze_user;

This is the minimum required permissions for this user; if creating multiple CDI integrations, you may want to grant permissions to a schema, or manage permissions using a group.

Step 3: Allow access to Braze IPs (optional)

If you have a firewall or other network policies in place, you will need to give Braze network access to to your Redshift instance. Allow access from the below IPs that correspond to the region of your Braze dashboard.

Create a new integration in the Braze dashboard

Navigate to the Redshift page on Braze, under Technology Partners, and click Create new import sync.

1. Add Redshift connection information and source table
   Input the information for your Redshift data warehouse and source table, then proceed to the next step.
   
   
   
2. Configure sync details
   Next, choose a name for your sync and input contact emails. We’ll use this contact information to notify you of any integration errors (e.g., access to the table was removed unexpectedly).
   
   
   You will also choose the data type and sync frequency. Frequency can be anywhere in the range of every 15 minutes to once per month. We’ll use the time zone configured in your Braze dashboard to schedule the recurring sync. Supported data types are Custom Attributes, Custom Events, and Purchase Events and the data type for a sync cannot be changed after creation.

Test connection

Once all configuration details for your sync are entered, click Test connection. If successful, you’ll see a preview of the data. If for some reason we can’t connect, we’ll display an error message to help you troubleshoot the issue.

Set up additional integrations or users (optional)

You may set up multiple integrations with Braze, but each integration should be configured to sync a different table. When creating additional syncs, you may reuse existing credentials if connecting to the same Redshift account.

If you reuse the same user across integrations, you will not be able to delete the user in the Braze dashboard until it’s removed from all active syncs.

Running the sync

Once activated, your sync will run on the schedule configured during setup. If you want to run the sync outside of the normal schedule for testing or to fetch the most recent data, click Sync Now. This run will not impact regularly scheduled future syncs.