Skip to main content

Set Up the Braze Integration

Learn how to connect Knak to Braze, configure your API credentials, then sync email templates directly to Braze.

Create a Braze API Key

  1. In Braze, go to Settings > APIs & Identifiers.

    App Settings > APIs & Identifiers navigation menu

  2. Select the API Keys view and click the Create New API Key button.

    Create API Key button.

  3. Enter a name for the key.

  4. Enable the required permissions under the Templates tab.

    • templates.email.create

    • templates.email.update

    • templates.email.info

    • templates.email.list

  5. Click Create API Key.

  6. Copy the value shown under Identifier.

    Copy icon for the identifier number.

Create the Integration in Knak

  1. In Knak, click Admin from the left navigation.

  2. Go to Integrations > Platforms.

    Integrations > Platforms navigation in the admin side of Knak.

  3. Find the Braze tile under All Platforms.

  4. Click Connect.

    Braze Integration tile with "Connect" button highlighted.

  5. Enter an Integration Name.

  6. Enter your Identifier Number into the API Key input field.

  7. Select your Dashboard from the drop-down menu.

  8. Select the Universal Link Format.

  9. Click Create New Integration.

    Braze integration configuration page in Knak.

Universal Link Format

The Universal Link Format setting tells Knak which email delivery provider Braze uses. Knak uses this information to add the correct HTML attribute to links that should open in a mobile app instead of a web browser.

Choose one of the following options:

Option

Select this if...

HTML Attribute Added

SparkPost (Default)

Braze sends your emails through SparkPost.

data-msys-sublink="open-in-app"

SendGrid

Braze sends your emails through SendGrid.

universal="true"

If you do not change this setting, SparkPost is selected by default.

Manage Your Integration

After setup, view your integration in the My Platform Connection list on the Integrations page.

From here, you can:

  • View the configuration

  • Edit the integration

  • Delete the integration

My Platform Connections section.

To connect a new integration or re-add a deleted one:

  1. Scroll to All Platforms.

  2. Find the Braze tile.

  3. Click Connect or Add Another Connection.

Braze integration tile with "Add Another Connection" button highlighted.

Sync an Email to Braze

After you finish building your email in Knak:

  1. Go to Actions > Sync.

    Actions menu expanded with Sync option visible.

  2. Confirm the Asset Name that will appear in Braze.

  3. Click Sync.

After the sync completes, your email appears in Braze under:

Templates > Email Templates

Troubleshooting Sync Issues to Braze

If an email fails to sync or re-sync to Braze, check the following before contacting support:

  • Check whether the template is archived in Braze. If the original template was archived on the Braze side after a previous sync, Knak cannot sync or re-sync to it. Unarchive the template in Braze, then retry the sync from Knak.

  • Check for unsupported merge tags. If your email uses a merge tag that Braze does not support (for example, a "View email on browser" tag), the sync will error. Remove or replace any merge tags Braze does not support, then retry the sync.

Need more help? Contact support via live chat within Knak using the chat bubble in the bottom right corner or email support@knak.com.

Related Articles
Did this answer your question?