Braze: Instructions for Initial ESP Set Up

⏳Completing these instructions should take around 1 hour.

The major steps involve:

  • Configuring general account settings within Braze
  • Creating a new role and a new Braze user for Da Vinci
  • Configuring Braze API access for Da Vinci
  • Creating a Campaign within Braze for Da Vinci
  • Configuring Braze Currents to export Message Engagement Events

 

🛑 IMPORTANT!  Read before continuing!

Throughout these instructions, you will be instructed to extract specific values from your Braze environment and provide them to Movable Ink for implementation of your Da Vinci account. Some of these values are secrets that should only be shared through a secure channel.

To ensure security, provide all requested values using the secure Dropbox folder configured and shared by your Movable Ink account team. Reach out to your account team if you have not yet received access to this Dropbox folder.

See the form at the bottom of this page for additional guidance.

 

User Logins Setup:

Please create a new user for Da Vinci. Here is the documentation for role creation in Braze.

This user should have a new “Movable Ink - Da Vinci” user role assigned, with the following permissions added to that user role:

  • Workspace - Access Campaigns, Canvases, Cards, Content Blocks, Feature Flags, Segments, Media Library, Locations, Promotion Codes, and Preference Centers
  • Workspace - Access Dev Console
  • Workspace - Manage Email Settings
  • Workspace - Send Campaigns, Canvases
  • Workspace - Edit Currents Integrations

Please note that this is a preferred list of UI permissions for the initial setup. Talk with your Movable Ink account team if you'd like this role to have reduced permissions after the initial setup period.

API Access:

Create App

In order to send messages, a Braze app is required.

  1. Within the Braze application, navigate to Settings > App Settings.
  2. Click on the Add App button and create a new app named "Movable Ink - Da Vinci" using the "Web" platform.
  3. Navigate to Settings > APIs and Identifiers > App Identifiers and find the new "Movable Ink - Da Vinci" app. Copy the value in the Identifier column. This will be needed by Movable Ink.

Create API Key

In order to make authenticated requests, a Braze API key is required. Here is the Braze documentation for adding an API key.

  1. Within the Braze application, navigate to Settings > APIs and Identifiers > API Keys.
  2. Click on the Create API Key button to create a new API key named "Movable Ink - Da Vinci".
  3. Provide the following API key permissions:
Permission Purpose
Messages > messages.send Send individual messages
Campaigns > sends.id.create Associate a common ID across a set of messages
Campaigns > campaigns.details Query for details of a specific campaign
Users > users.export.ids Identify a user's reference ID values for internal testing
  1. Once created, copy the value in the Identifier column for the new API Key. This will be needed by Movable Ink.

Determine REST Endpoint

The REST Endpoint associated with your account will be needed by Movable Ink. This value can be copied from the Braze docs found here.

Campaign Setup:

All messages sent by Movable Ink via Braze are organized together through a campaign.

  1. Within the Braze application, navigate to Messaging > Campaigns.
  2. Click on the Create Campaign > API Campaign button and create a new campaign named "Movable Ink - Da Vinci Email". Select the Email channel button.
  3. Copy the provided Campaign ID and Email Variation ID values. These will be needed by Movable Ink.
  4. Under Additional Options select the following:
    1. Allow users to become re-eligible to receive this campaign
    2. Don't count this Campaign toward the frequency capping send limit

Any message sent by Movable Ink via Braze will be visible via this newly created campaign.

General Account Information:

Provide your Movable Ink account with the following information:

  • The From Email, From Description, and Reply-To Email that you'd like Da Vinci campaigns to use by default
  • Your preference for Da Vinci campaign sends define the email recipient within Braze using external ID or user alias
  • Estimate your maximum list size per campaign & maximum number of campaigns per day - these will help Movable Ink determine if your Braze account's standard API rate limits will be sufficient for your needed email throughput

Currents Setup:

Movable Ink’s Integration will export campaign event data via Braze’s Currents offering. 

In order for Movable Ink to understand the final results of a message sent by Braze, we need a webhook-based Current setup to provide this data to us.

  1. Within the Braze application, navigate to Partner Integrations > Data Export.
  2. Click on the Create New Current > Custom Currents Export button and create a new Current named "Movable Ink - Da Vinci Webhooks".
  3. Enter the Email provided by Movable Ink for the Contact Email field.
  4. Movable Ink will provide you with a unique Endpoint and Bearer Token value to fill in.
  5. Under Message Engagement Events - select the following event types:
    1. Email Abort
    2. Email Bounce
    3. Email Delivery
    4. Email Mark as Spam
    5. Email Soft Bounce
    6. Email Unsubscribe

Movable Ink will now receive details on all the messages we send via the Braze platform.

Provide the following back to Movable Ink...

Post a text file into the secure Dropbox folder shared by your Movable Ink account team with the following values.  Do not send these values via email or other insecure channels.  After you post this file, email your Movable Ink account team to inform them that it has been shared and then delete this text file from your local workstation.

  • General Account Information...
    • Default From Email:
    • Default From Description:
    • Default Reply-To Email:
    • Preference to use external ID or user alias to define the email recipient:
    • Estimated maximum list size per campaign:
    • Estimated maximum number of campaigns per day:
  • API Access...
    • App Identifier: 
    • API Key Identifier:
    • REST Endpoint: 
  • Campaign...
    • Campaign ID:
    • Email Variation ID:
  • Currents...
    • Confirmation that Custom Currents Export (webhooks) has been configured (Y/N):

Was this article helpful?

/