MoEngage technical setup for Jacquard

For MoEngage admins and developers. Covers the runtime key, the Content API, engagement data export and the API connection.

Technical setup

For your MoEngage 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: MoEngage Content API

• Scopes: runtime:select

• Integration type: Other

• Leave other fields blank. Click Create key.

1.2 Copy the key

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

2. MoEngage | Create the Content API

2.1 Open Content APIs

In MoEngage, go to Settings > APIs > Content API and create a new Content API.

2.2 Set the details

• API name: jacquardContentAPI

• URL: https://runtime.platform.jacquard.com/api/v1/select/{{CampaignAttribute['_id']}}?recipient_id={{UserAttribute['ID']}}&delivery_id={{CampaignAttribute['_id']}}

• Headers tab: x-api-key = your jq_live_ key

2.3 Save

The Content API is now available in campaigns and flows.

2.4 Existing customers

Create a new Content API. Don’t edit your existing Jacquard Content API.

3. MoEngage | Send engagement data to Amazon S3

Required. Opens, clicks and other engagement data come through this export.

3.1 Get S3 details (Jacquard does this)

Jacquard sends the connection name, bucket name and bucket region through a secure channel.

3.2 Add the integration

In MoEngage, go to App Marketplace, search S3, open Integrate and click + Add Integration.

3.3 Set the details

• Connection name, bucket name, bucket region: as provided by Jacquard.

• Events: Email Opened, Email Clicked. For push, also Notification Clicked Android and Notification Clicked iOS.

• User properties: id (Tracked Standard Attribute).

3.4 Connect

Click Test Connect, then Connect. Tell your Jacquard contact.

API connection

Connects your MoEngage account to Jacquard. Part 1 is still required.

4. MoEngage | API connection

4.1 Open API keys

In MoEngage, go to Settings > Account > API Keys. Direct link: https://dashboard-0N.moengage.com/v4/settings-v2/accounts/api-keys.

4.2 Create the key

• Click Create API Key. Name: Jacquard.

• Permission: Campaigns > View only.

• Save and copy the key. It’s shown once only.

4.3 Use the Campaigns key

Don’t use the Data API key. It authenticates, but the campaigns endpoints refuse it.

4.4 Older workspaces

If you only see separate per-feature keys and no API Keys dashboard, ask MoEngage to enable the API Keys dashboard.

4.5 Workspace ID

• Go to Settings > App Settings. Copy the Workspace ID (APP ID).

• This is also the Basic auth username.

4.6 Data centre

The number in your dashboard URL: dashboard-0N.moengage.com → api-0N.

4.7 Open the connector

In Jacquard, go to Connectors > MoEngage > Connect.

4.8 Enter the details

• Name for this connection: for example MoEngage. Shown wherever the connection is referenced.

• MoEngage Campaigns API key: the Campaigns API key you created.

• MoEngage Workspace ID (APP ID): the Workspace ID you copied.

• MoEngage data centre: for example api-01.

4.9 Save

Click Save connection. Results show in the next discovery run.

Ready to send emails

1. Confirm setup (Jacquard does this)

   Your Jacquard contact confirms the Content API and engagement data work.

2. Hand over

   Send your marketing team the Content API name.

3. Configure your templates

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

Reference

Reference and troubleshooting

Troubleshooting

Snippet returns fallback copy

Check the URL is exact, the header is named x-api-key, and the key is active with runtime:select scope.

S3 Test Connect fails

Check the bucket name and region match exactly. Contact Jacquard support if it still fails.

API connection troubleshooting

Key authenticates but campaigns are refused

You used the Data API key. Create a key with Campaigns > View access.

Authentication fails

Check the data centre matches your dashboard URL and the Workspace ID is correct.

Disconnect

Delete the key in MoEngage. Content API 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).