Skip to content
Blackbird docs

Braze

View on Github

Braze is a customer engagement platform that helps brands deliver personalized, real-time messaging across channels like email, mobile, SMS, and web.

Before setting up

Before you can connect you need to make sure that:

  • You have access to a Braze instance and the right permissions to create API keys.
  • Create an API key under Settings > APIs and identifiers > API Keys > Create API Key.
    • Under permissions grant all permissions for Campaigns and Canvas

Connecting

  1. Navigate to apps and search for Braze.
  2. Click Add Connection.
  3. Name your connection for future reference e.g. ‘My Braze’.
  4. Fill in the Braze instance your account is on. You can find a table of instances here.
  5. Fill in the API Key obtained earlier.
  6. Click Connect

Actions

Campaigns

  • Search campaigns returns a list of campaigns. Searchable by last edited date.

  • Get campaign returns campaign metadata.

  • Download campaign message downloads the campaign message in both JSON and HTML formats. Use in conjunction with Upload campaign message after translation.

  • Upload campaign message uploads the campaign message content from a translated file. use in conjunction with Download campaign message.

  • Add translation tags to email template given an email template, automatically adds the {% localization id_x } tags around translatable content.

Canvases

  • Search canvases returns a list of canvases. Searchable by last edited date.
  • Get canvas gets all details of a specific canvas
  • Download canvas message downloads the canvas message in both JSON and HTML format
  • Upload canvas message uploads the canvas message content from a translated file

Events

  • On canvas updated triggers when a canvas is updated
  • On campaign updated triggers when a campaign is updated
  • On campaign message tag added triggers when a campaign message tag is added
  • On canvas message tag added triggers when a canvas message tag is added

Example

example

This workflow triggers whenever a campaign is updated in Braze. It automatically downloads the campaign message, creates a translation job in Phrase TMS, waits for the job to complete, pulls down the translated content, uploads the localized campaign back into Braze, and finally sends a Slack notification confirming that the translated campaign is live.

Feedback

Do you want to use this app or do you have feedback on our implementation? Reach out to us using the established channels or create an issue.