Create a recipe in Sitecore Connect
Before you can connect a recipe to an audience export in CDP, you first need to create one in Sitecore Connect. A recipe provides a webhook address and defines the action to perform such as retrieving audience export data from CDP.
This walkthrough describes how to:
Generate a webhook address and set up the payload schema
To generate a webhook address and set up the payload schema:
-
In Sitecore Connect, in a project, click Create > Recipe.
-
In the Set up your recipe window, click Trigger from a webhook, then click Start building.
-
In the Setup pane, click setup manually.
-
In the Event name field, enter a unique event name, for example, CDP to Connect. An HTTPS webhook URL displays.
-
In the Payload configuration section, click Use JSON under Payload schema.
-
In the Generate schema window, paste the following JSON sample, then click Next.
RequestResponse{ "audienceExportExecutionRef": "", "friendlyId": "", "clientKey": "", "audienceExportRef": "" } -
Review the schema preview, then click Generate schema.
-
In the Payload configuration section, the JSON schema is now added to the Payload schema section.
Add a Sitecore CDP action to the recipe
After configuring the webhook and payload, continue by adding a Sitecore CDP action to the recipe. This enables you to define a specific action to perform on the audience export output in Sitecore Connect.
To add a CDP action to the recipe:
-
On the recipe canvas, below Actions, click the plus icon and select Action in an app.
-
In the App pane, search for Sitecore CDP then click it.
-
In the Action pane, choose the CDP action you want to perform. For example:
-
Audience Export - Get latest files
-
Audience Export - Get files by execution ref
-
Audience Export Delta - Get latest files
-
Audience Export Delta - Get files by execution ref
-
Upload a batch file to Sitecore CDP
-
Get status of your batch file upload
-
Custom action
In this procedure, we select Audience Export Delta - Get latest files as an example.
TipFor specific use cases, see the walkthroughs to create these recipes: Receive the latest output in Sitecore Connect and Receive a specific output in Sitecore Connect.
-
-
In the Connection pane, if you already have an active connection to use, select it. Otherwise, click New connection, complete the following fields, then click Connect.
-
Client key and API token - find these values in Sitecore CDP by clicking
> API access. -
Client ID and Client secret - the client ID is the API key, and the client secret is the API secret. Find these values by creating an API key in Sitecore CDP > Developer Center > API keys.
-
AWS region - find this value in Sitecore CDP by clicking
> Company information > Environment.
-
-
In the Setup pane, locate the Audience export ref field.
-
At the bottom right corner of the recipe canvas, expand Recipe data.
-
In Step 1 output, in Payload, click and drag the Audience export ref field into the Audience export ref field.
The Audience export ref identifies the audience export. By specifying the friendly ID in the Audience export ref field, you ensure that Sitecore Connect retrieves the URLs of the latest output of the exact audience export you want to receive.
-
Click Save, then click Exit to close the recipe editor.
-
Click Start recipe. The recipe now shows an Active status.
Your Sitecore Connect recipe is now ready. Next, go to Sitecore CDP and connect the recipe to an audience export. After connecting, each time the audience export runs, the webhook triggers the connected recipe and performs the defined action.