Guides: New customer setup · Existing customers: moving to the new Jacquard · API connection (optional) · All guides
Optional, for new and existing customers. Connecting a Braze REST API key lets you import your campaigns and Canvases into Jacquard as touchpoints, and lets Jacquard check your wiring before go-live. You still need the Connected Content blocks from the setup or move guide. Jacquard can’t send, launch or stop anything in Braze.
Your account details. Your Jacquard contact will give you your own account URLs and values. Wherever you see a value in angle brackets, such as https://<jacquard-callback-url>, use the value we’ve given you for your account.
Who does this: A Braze admin who can create REST API keys in your workspace.
New customers: Any time once you have access to Jacquard, before or after the setup guide.
Existing customers: From stage 2 of your move, once you’ve accepted your invitation. It doesn’t change your sends. See the move guide.
Without a connection | With a connection |
|---|---|
You set up touchpoints in Jacquard with your contact | You import campaigns and Canvases as touchpoints yourself |
You copy campaigns and add blocks yourself | Jacquard can duplicate a campaign into a managed copy |
A test send is your check | Jacquard reads back your wiring and flags gaps before go-live |
Connect your Braze account
Optional. Your Braze admin creates one REST API key; Jacquard uses it to import touchpoints and check your wiring.
1.1 Create a REST API key
Find your REST endpoint
Your REST endpoint matches the cluster in your Braze dashboard URL. For example,
dashboard-01.braze.comusesrest.iad-01.braze.com, anddashboard-01.braze.euusesrest.fra-01.braze.eu. Braze’s API endpoints page lists every cluster.Open the right workspace
API keys belong to one workspace. Switch to the workspace that holds the campaigns and Canvases you want Jacquard to optimise. Repeat these steps for each additional workspace.
Create a REST API key
Go to Settings > APIs and Identifiers, open the API Keys tab and click Create API key. Name it
Jacquard.Tick only the ten permissions below
Leave everything else unticked. If you use IP allowlisting, ask your Jacquard contact for the addresses to add:
<jacquard-egress-ips>.Save and copy the key
Save the key and copy it for the next step.
Permissions
Permission | Why Jacquard needs it |
|---|---|
campaigns.list | List campaigns so you can import them |
campaigns.details | Read campaign content to check what’s wired |
campaigns.duplicate | Duplicate a campaign into a Jacquard-managed copy |
canvas.list | List Canvases so you can import them |
canvas.details | Read Canvas content |
content_blocks.list | Find the Jacquard Connected Content blocks |
content_blocks.info | Read a content block’s body |
content_blocks.create | Create the Connected Content blocks that call Jacquard |
content_blocks.update | Keep those blocks up to date |
templates.email.info | Read email template content |
Not needed: campaign or Canvas send and trigger permissions, user or subscriber APIs, KPI and analytics exports, segments, catalogs or custom events. Jacquard can’t send, launch or stop anything in Braze. The key is sent as Authorization: Bearer <rest_api_key>.
1.2 Connect and import your touchpoints
Connect Braze in Jacquard
In Jacquard, open Connections > Braze > Connect. Enter the key and your REST endpoint hostname (for example
rest.iad-01.braze.com, withouthttps://), then click Save connection. The button changes to Connected once Jacquard has tested it.Sync your campaigns and Canvases
Click Sync. Jacquard reads the campaigns and Canvases in the workspace. Nothing in Braze changes.
Import your touchpoints
Choose the campaigns and Canvases you want to optimise and import them as touchpoints. Large workspaces bring back a long list, so search by name. Only what you import is affected.
1.3 What changes once you’re connected
You still need your Connected Content blocks
Connecting doesn’t replace the Connected Content blocks. Your admin still creates them as described in the setup guide or move guide. Don’t rename, edit or archive them.
Campaigns: review Jacquard’s copy and launch it
Jacquard can duplicate a campaign into a managed copy with the block already in place. Open the copy, check its audience, schedule and conversion events, then launch it. Stop or archive the original so the two don’t send to the same people.
Canvases: add the block yourself
Jacquard can read Canvases but can’t edit them. Your marketing team still adds the block reference and variables to each Canvas message step, as in the setup guide.
Run delivery verification
On each touchpoint in Jacquard, run verification. Jacquard reads back what’s in Braze and flags anything missing before you activate.
Reference
What to check when something doesn’t look right.
Troubleshooting
Jacquard says the connection failed
Check the endpoint matches your dashboard cluster, the key was created in the right workspace, and all ten permissions are ticked. If you use IP allowlisting, check Jacquard’s addresses are on it.
The sync shows hundreds of old campaigns
That’s expected in busy workspaces. Search by name; only campaigns you import as touchpoints are affected.
You want to disconnect
Delete the key in Braze. Jacquard stops importing and checking your campaigns, but your blocks and sends keep working.
Handling secrets safely
Keys, tokens and secrets on this page give access to your account. Enter them directly into Jacquard’s Connections screen or share them through the secure channel your Jacquard contact sets up. Never paste them into email, chat, tickets or shared documents. If one is exposed, create a replacement, update it wherever it’s used, then revoke the old one. For Jacquard keys, you do this under Admin > API keys & webhooks.