AJO technical setup for Jacquard

Prev Next

For Adobe Journey Optimizer admins and developers. Covers the runtime key, the Custom Action and click data export.

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 Custom Action and destination keep working.

Technical setup

For your AJO 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: AJO Custom Action

  • 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. AJO | Create the Custom Action

2.1 Create the action

In AJO, go to Administration > Configurations > Actions and create a new Custom Action. Name: jacquardAPI.

2.2 Endpoint

  • Method: as shown on the touchpoint’s Connect tab in Jacquard.

  • URL: the endpoint on the Connect tab.

  • Header: name and format as shown on the Connect tab, using your jq_live_ key.

  • Query parameters: as listed on the Connect tab, set as variable.

  • Authentication: none (the header covers it).

2.3 Response payload

Paste the sample response from the Connect tab. Set all fields to string.

2.4 Save

Scroll to the top of the panel and click Save.

2.5 Existing customers

Create a new Custom Action. Don’t edit your existing Jacquard action.

3. AJO | Send click data to Amazon S3

Recommended.

Existing customers: keep your existing S3 destination. Skip this section.

Cost: Adobe may charge for Destinations. Check with your Adobe representative.

3.1 Get S3 details (Jacquard does this)

Jacquard sends the access key, secret key, bucket and folder path through a secure channel.

3.2 Create the destination

  • Go to Connections > Destinations > Catalog, search S3, click Set up.

  • Enter the access key and secret key.

  • Data type: Datasets. Name: e.g. Jacquard click tracking.

  • Bucket and folder path: as provided.

  • Governance label: optional. Click Create.

3.3 Export the dataset

  • Open the destination and click Export datasets.

  • Select AJO Email Tracking Experience Event Dataset.

  • Frequency: daily. Click Finish.

Click data is used for reporting and model training, not in-send optimisation. AJO exports run at 3 hours minimum.

Ready to send emails

  1. Confirm setup (Jacquard does this)

    Your Jacquard contact confirms the Custom Action and click data work.

  2. Hand over

    Send your marketing team the Custom Action name.

  3. Configure your templates

    See the guide on configuring your templates: Set up AJO journeys and messages for Jacquard.

Reference

Reference and troubleshooting

Item

Source

Destination

jq_live_ runtime key

Jacquard Admin > API keys & webhooks

Custom Action header

Endpoint, parameters, sample response

Touchpoint Connect tab

Custom Action

S3 keys, bucket, folder path

Jacquard (secure channel)

AJO S3 destination

Troubleshooting

Action returns no content

Check the endpoint, header and parameters match the Connect tab, and the key is active with runtime:select scope.

Fields missing in personalisation

Re-paste the sample response and set every field to string.

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).