Braze

This guide will walk you through connecting your Braze account to Composa, enabling you to export email templates directly to Braze.

Prerequisites

Before connecting, you'll need:

  • A Braze account with administrator access

  • Your Braze REST API Key (with email template permissions)

  • Your Braze instance identifier (e.g., US-01, US-02, EU-01)

Connecting Braze

Step 1: Locate Your Braze Instance

Your Braze instance identifier is shown in the Braze dashboard URL or in your account settings. Common instances include:

  • US-01, US-02, US-03, US-04 (United States)

  • EU-01 (Europe)

  • AP-01 (Asia Pacific)

Step 2: Get Your REST API Key

  1. Log in to your Braze dashboard

  2. Navigate to Settings > API Keys

  3. Create a new API Key or use an existing one

  4. Ensure the key has permissions for Email Template management

  5. Copy the API Key value

Step 3: Connect in Composa

  1. In Composa, go to Settings > Integrations

  2. Find Braze and click Connect

  3. Select your Braze instance from the dropdown

  4. Paste your Braze REST API Key in the provided field

  5. Click Save

Composa will validate your credentials. Once validation is complete, your Braze integration is active.

Exporting Templates to Braze

Once connected, exporting a template to Braze is simple:

  1. Open a template in the Composa editor

  2. Click the Export button in the toolbar

  3. Select Export to Braze

  4. Your template is created as a new email template in your Braze account

  5. You can now use this template in your Braze campaigns

Template Details

When you export a template to Braze:

  • The template name matches the template name in Composa

  • The template includes all HTML, styling, and content from your Composa template

  • The template is created in an unpublished state, allowing you to review it before use

  • Any images or assets are embedded or linked based on Composa's export settings

Disconnecting Braze

To remove the Braze integration:

  1. Go to Settings > Integrations

  2. Find Braze in the list

  3. Click Disconnect

Your Braze account and any previously exported templates remain unchanged. You can reconnect at any time.

Troubleshooting

"Invalid API Key" Error

  • Verify that your REST API Key is correct

  • Confirm that the key has email template permissions enabled

  • Check that the key hasn't expired in your Braze dashboard

"Instance Not Found" Error

  • Double-check that your Braze instance identifier is correct

  • Ensure your instance matches your Braze dashboard location

Export Fails

  • Verify that your Braze integration is still active in Settings > Integrations

  • Check that your API Key still has the necessary permissions

  • Try disconnecting and reconnecting your Braze account

Need Help?

For additional support:

Last updated