Skip to main content

Braze integration

This guide walks you through connecting Braze to Better Email, exporting email templates, and optionally syncing custom attributes for merge tags and segmentation.

Before you start​

To connect Braze, you will need:

  • a Braze account with access to REST API keys
  • your Braze REST instance URL
  • a Braze REST API key for Better Email
  • an admin user in Better Email who can create and edit integrations

1. Find the Braze values Better Email needs​

In Braze, collect:

  • your Instance URL
  • your API Key

For the instance URL, Better Email expects the REST host, not the dashboard URL.

Example:

  • Dashboard URL: dashboard-01.braze.eu
  • Instance URL to use in Better Email: rest.fra-01.braze.eu

2. Set up the integration in Better Email​

In Better Email:

  1. Go to Integrations.
  2. Create a new integration.
  3. Enter a clear name for the integration.
  4. Choose Braze as the type.
  5. Optional: under Access, restrict the integration to specific users or groups.
  6. Save the integration.
  7. Enter the Instance URL and API Key.
  8. Enable the integration.
  9. Save the integration again.

TODO: Add a screenshot of the Braze integration settings showing the instance URL format and API key field.

3. Export to Braze​

Once the integration is active, Better Email can create or update Braze email templates.

Important to know:

  • Better Email stores the Braze template ID after the first export.
  • Re-exporting the same email updates that tracked template instead of creating a duplicate.
  • Merge tags and segmentation are rendered using Braze-compatible syntax.

4. Optional: sync recipient fields from Braze​

Braze can also provide custom attributes for merge tags and segmentation.

To turn that on:

  1. Open the Braze integration.
  2. Turn on Sync recipient fields.
  3. Save the integration.
  4. Go to Recipient Fields.
  5. Run Sync from <integration name>.

Better Email reads the available Braze custom attributes and maps them into recipient fields.

Troubleshooting​

If export or sync fails, check:

  • the instance URL is the REST URL, not the dashboard URL
  • the API key is still active and has the necessary permissions
  • the integration is enabled in Better Email
  • the right users or groups have access to the integration