Guides: New customer setup · Existing customers: moving to the new Jacquard · API connection (optional) · All guides
Optional, for new and existing customers. Connecting an Iterable API key lets you import your campaigns and journeys into Jacquard as touchpoints, and lets Jacquard check your template wiring before go-live. Jacquard can’t send campaigns or change your users or lists.
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: An Iterable project admin who can create API keys.
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 journeys as touchpoints yourself |
Your marketing team wires every template by hand | Jacquard can create its own template with the wiring in place |
A proof send is your check | Jacquard reads back your wiring and flags gaps before go-live |
Connect your Iterable account
Optional. Your Iterable admin creates one API key; Jacquard uses it to import touchpoints and check your wiring.
1.1 Create an API key
Create a dedicated API key
In Iterable, go to Integrations > API Keys and click New API Key. Name it
Jacquardso it’s easy to find and revoke later.Choose a server-side key type. If your project lets you pick individual permissions, grant only the five in the table below.
Copy the key straight away
Iterable only shows the full key once. Keep it somewhere secure for the next step.
Permissions
Permission | Why Jacquard needs it |
|---|---|
Campaigns: Read | List and read campaigns so you can import them |
Campaigns: Write | Create and activate the triggered campaign copies Jacquard provisions |
Templates: Read | Read email templates and check the wiring |
Templates: Write | Create and update the Jacquard-owned template that holds the data feed wiring |
Workflows / Journeys: Read | List journeys so you can import them. Leave this out if you don’t need journeys |
Not needed: Webhooks, Lists, Users/Contacts, Catalogs, Events or Export API permissions. The key is sent as an Api-Key header to api.iterable.com.
1.2 Connect and import your touchpoints
Connect Iterable in Jacquard
In Jacquard, open Connections > Iterable > Connect, paste the key and click Save connection. Jacquard tests the key and the button changes to Connected.
Sync your campaigns
Click Sync. Jacquard reads your campaigns, templates and journeys. Nothing in Iterable changes.
Import your touchpoints
Choose the campaigns you want to optimise and import them as touchpoints. Only what you import is affected.
1.3 What changes once you’re connected
Template wiring
Jacquard can create its own template with the data feed wiring already in place. Your admin still creates the data feeds and events webhook as in the setup guide.
Run delivery verification
On each touchpoint’s delivery checklist, run verification. Each check can take up to a minute.
Fix anything it flags
Code
What it means
What to do
DATA_FEED_MISMATCH
The template has the wrong feed, or more than one feed
Detach every feed except the one whose ID you entered in Jacquard, then recheck
SELECTED_REGIONS_MISMATCH
A part selected in Jacquard isn’t wired in the template
Wire it or deselect it on the touchpoint, then recheck
Reference
What to check when something doesn’t look right.
Troubleshooting
Jacquard says the connection failed
Check the key is server-side, hasn’t been revoked, and has the five permissions.
Verification keeps flagging a mismatch
Checks can take up to a minute. Wait, then recheck after each fix.
You want to disconnect
Revoke the key in Iterable. Existing feeds and sends keep working; Jacquard just can’t import or verify.
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.