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 create REST API keys
  • An admin user in Better Email who can create and edit integrations

1. Create a REST API key in Braze​

  1. In Braze, go to Settings → API and Identifiers
  2. Select the API Keys tab
  3. Click Create API key
  4. Fill in the form:
    • API key name: Better Email integration
    • Allowlist IPs: Leave blank
    • Permissions: Expand Email and Templates and select all permissions within each. If you want performance data available in Better Email, also expand User Data and select the relevant permissions.
  5. Click Create API key

2. Copy your credentials into Better Email​

On the API key detail page, Braze shows both values you need:

  1. Next to REST Endpoint, click the copy icon and paste the value into the Instance URL field in Better Email
  2. Next to your API key, click the copy icon and paste the value into the API Key field in Better Email

Note: The Instance URL should be a hostname only — do not include https://. If the copied value includes it, remove it before saving.

3. Save and enable the integration in Better Email​

  1. Go to Integrations in Better Email
  2. Create a new integration or open an existing one
  3. Choose Braze as the type
  4. Paste in the Instance URL and API Key from the previous step
  5. Check Enabled
  6. Click Save

The integration is now active and ready to use.

4. Export to Braze​

Once the integration is active, you can export email templates directly to Braze from the export dialog.

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

5. Optional: sync recipient fields from Braze​

To use Braze custom attributes as merge tags and segmentation in Better Email:

  1. Open the Braze integration
  2. Check Sync recipient fields
  3. Click Save
  4. Go to Recipient Fields
  5. Click Sync from [integration name]

Better Email will read the available Braze custom attributes and map them into recipient fields.

Troubleshooting​

SymptomFix
Failed to open TCP connection to https:443The Instance URL contains https:// — remove the protocol prefix and enter the hostname only
Name or service not knownThe Instance URL is incorrect — copy it again from the REST Endpoint field on your API key page in Braze
Export failsVerify that the integration is enabled and that the API key has Email and Templates permissions
API key rejectedThe key may have been deleted in Braze — create a new one and update the integration