Braze technical setup for Jacquard

Prev Next

For Braze admins and developers. Covers the runtime key, Connected Content credential and blocks, Currents, and the API connection.

Placeholders: example values (for example names in code) and values in angle brackets are account-specific. Your Jacquard contact provides them.

Existing customers: only needed for new touchpoints. Existing blocks, credential and Current keep working.

Technical setup

For your Braze admin or developer. Doesn’t affect existing sends.

1. Jacquard | Create the Jacquard runtime key

1.1 Create the key

  • In Jacquard, go to Admin > API keys & webhooks and click + New API key.

  • Name: Braze Connected Content

  • Scopes: runtime:select

  • Integration type: Braze

  • Leave other fields blank. Click Create key.

1.2 Copy the key

The key starts jq_live_. It’s shown once only.

2. Braze | Add the Connected Content credential

2.1 Add a credential

In Braze, go to Settings > Connected Content (older dashboards: Manage Settings > Connected Content).

2.2 Set the details

  • Name: the credential name on the touchpoint’s Connect tab, for example jacquard_credential.

  • Authentication: token, as shown on the Connect tab.

  • Value: your jq_live_ key.

2.3 Existing customers

Add a new credential. Don’t edit your current Jacquard credential.

3. Braze | Create the Connected Content blocks

3.1 Copy the block code

From the touchpoint’s Connect tab in Jacquard.

3.2 Create the block

  • In Braze, go to Templates > Content Blocks and click Create Content Block.

  • Name: as shown on the Connect tab, for example jacquard_touchpoint.

  • Paste the code and save.

3.3 Check the block

  • It refers to the credential by name.

  • It doesn’t contain the key.

  • The rest of the code is unedited.

3.4 Repeat

One block per touchpoint.

4. Braze | Send events with Currents

Existing customers: keep your existing Current. Skip this section.

Licence: Currents is a paid Braze add-on. Each Current is billed separately.

4.1 Get destination details (Jacquard does this)

Jacquard sends them through a secure channel. For Amazon S3: Access Key ID, Secret Access Key, bucket name, folder name.

4.2 Create the Current

  • Go to Partner Integrations > Data Export (older dashboards: Integrations > Currents) and click Create New Current.

  • Destination: as specified by Jacquard.

  • Name: Jacquard.

  • Add a contact email and the credentials. Bucket and folder names are case sensitive.

4.3 Select events

  • Tick Include events from anonymous users.

  • Email Send, Email Open, Email Click, Email Bounce, Email Unsubscribe, Purchase.

4.4 Remove personal data

On Field Transformation Configuration, set EMAIL_ADDRESS and other personal fields to Removed.

4.5 Launch

Launch the Current and tell your Jacquard contact.

API connection

Imports touchpoints and checks wiring. Part 1 is still required.

5. Who and when

Who

Braze admin with permission to create REST API keys.

New customers

Any time after you have Jacquard access.

Existing customers

Any time from upgrade stage 2. Doesn’t affect sends.

What it adds

Without

With

Touchpoints set up with your Jacquard contact

Import campaigns and Canvases as touchpoints

Copy campaigns and add blocks manually

Jacquard can duplicate a campaign with the block in place

Test send only

Jacquard checks wiring before go-live

6. Braze | Create a REST API key

6.1 Find your REST endpoint

Matches your dashboard cluster: dashboard-01.braze.com → rest.iad-01.braze.com; dashboard-01.braze.eu → rest.fra-01.braze.eu.

6.2 Select the workspace

Keys are per workspace. Repeat for each workspace.

6.3 Create the key

  • Go to Settings > APIs and Identifiers > API Keys and click Create API key.

  • Name: Jacquard.

  • Tick only the permissions below.

  • IP allowlisting: add <jacquard-egress-ips>.

Permission

Purpose

campaigns.list

List campaigns

campaigns.details

Read campaign content

campaigns.duplicate

Create Jacquard-managed campaign copies

canvas.list

List Canvases

canvas.details

Read Canvas content

content_blocks.list

Find Jacquard blocks

content_blocks.info

Read block content

content_blocks.create

Create Jacquard blocks

content_blocks.update

Update Jacquard blocks

templates.email.info

Read email templates

Jacquard can’t send, launch or stop anything in Braze.

7. Jacquard | Connect and import

7.1 Connect

In Jacquard, go to Connectors > Braze > Connect. Enter the key and REST endpoint hostname (no https://). Click Save connection.

7.2 Sync

Click Sync. No changes are made in Braze.

7.3 Import

Select campaigns and Canvases to import as touchpoints.

8. Braze | After connecting

8.1 Duplicated campaigns

Check audience, schedule and conversion events, then launch. Stop the original.

8.2 Canvases

Jacquard can’t edit Canvases. Add the block and variables manually.

8.3 Verification

Run delivery verification on each touchpoint before activating.

Ready to send emails

  1. Confirm setup (Jacquard does this)

    Your Jacquard contact confirms the credential, blocks and events work.

  2. Hand over

    Send your marketing team the block name for each touchpoint.

  3. Configure your templates

    See the guide on configuring your templates: Set up Braze messages for Jacquard.

Reference

Reference and troubleshooting

Item

Source

Destination

jq_live_ runtime key

Jacquard Admin > API keys & webhooks

Braze credential

Credential name

Touchpoint Connect tab

Braze credential

Block code and name

Touchpoint Connect tab

Braze Content Blocks

Currents destination details

Jacquard (secure channel)

Braze Current

Troubleshooting

Block preview shows an error

Check the key is active with runtime:select scope, the credential holds it, and the block uses the exact credential name.

No events in Jacquard

Check the Current is launched, bucket and folder names match, and Braze hasn’t emailed an export error.

API connection troubleshooting

Connection failed

Check the endpoint, workspace, all ten permissions and IP allowlist.

Disconnect

Delete the key in Braze. Blocks and sends keep working.

Keys and tokens

  • Don’t share keys by email, chat, tickets or shared documents.

  • If a key is exposed: create a new one, update it everywhere, revoke the old one (Admin > API keys & webhooks).