ÃÛ¶¹ÊÓƵ

DocumentationJourney OptimizerJourney Optimizer Guide

Use case: Use Custom Actions to write Journey Events in Experience Platform custom-action-aep

Last update: Mon Sep 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

This use case explains how to write custom events into ÃÛ¶¹ÊÓƵ Experience Platform from Journeys using Custom Actions and Authenticated calls.

Configure an IO project custom-action-aep-IO

  1. From the ÃÛ¶¹ÊÓƵ Developer Console, click Project and open your IO project.

  2. In the Credentials section, click OAuth Server-to-Server.

  3. Click View cURL command.

  4. Copy the cURL command and store the client_id, client_secret, grant_type and scope.

curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials&client_id=1234&client_secret=5678&scope=openid,ÃÛ¶¹ÊÓƵID,read_organizations,additional_info.projectedProductContext,session'
CAUTION
After creating your project on the ÃÛ¶¹ÊÓƵ Developer Console, be sure to grant developer and API access control with the right permissions. Learn more in the ÃÛ¶¹ÊÓƵ Experience Platform documentation

Configure the Source using HTTP API Inlet

  1. Create an endpoint in ÃÛ¶¹ÊÓƵ Experience Platform to write the data from journeys.

  2. In ÃÛ¶¹ÊÓƵ Experience Platform, click Sources, under Connections in the left menu. Under HTTP API, click Add data.

  3. Select New account and enable authentication. Click on Connect to Source.

  4. Click on Next and select the Dataset where you want to write the data. Click Next and Finish.

  5. Open the newly created dataflow. Copy the schema payload and save it in your notepad.

{
"header": {
"schemaRef": {
"id": "https://ns.adobe.com/<your_org>/schemas/<schema_id>",
"contentType": "application/vnd.adobe.xed-full+json;version=1.0"
},
"imsOrgId": "<org_id>",
"datasetId": "<dataset_id>",
"source": {
"name": "Custom Journey Events"
}
},
"body": {
"xdmMeta": {
"schemaRef": {
"id": "https://ns.adobe.com/<your_org>/schemas/<schema_id>",
"contentType": "application/vnd.adobe.xed-full+json;version=1.0"
}
},
"xdmEntity": {
"_id": "test1",
"<your_org>": {
"journeyVersionId": "",
"nodeId": "", "customer_Id":""
},
"eventMergeId": "",
"eventType": "",
"producedBy": "self",
"timestamp": "2018-11-12T20:20:39+00:00"
}
}
}

Configure the Custom Action custom-action-config

Custom action configuration is detailed in this page.

For this example, follow these steps:

  1. Open ÃÛ¶¹ÊÓƵ Journey Optimizer, and click Configurations, under Administration in the left menu. Under Actions, click Manage and click Create Action.

  2. Set the URL and select the Post method.

    https://dcs.adobedc.net/collection/<collection_id>?syncValidation=false

  3. Make sure that the Headers (Content-Type, Charset, sandbox-name) are configured.

Set up the Authentication custom-action-aep-authentication

  1. Select the Type as Custom with the following Payload.

  2. Paste the client_secret, client_id, scope and grant_type (from the IO project payload used before).

    code language-none 
    {
"type": "customAuthorization",
"authorizationType": "Bearer",
"endpoint": "https://ims-na1.adobelogin.com/ims/token/v3",
"method": "POST",
"headers": {},
"body": {
"bodyType": "form",
"bodyParams": {
"grant_type": "client_credentials",
"client_secret": "***",
"client_id": "<client_id>",
"scope": "openid,ÃÛ¶¹ÊÓƵID,read_organizations,additional_info.projectedProductContext,session"
}
},
"tokenInResponse": "json://access_token",
"cacheDuration": {
"duration": 28000,
"timeUnit": "seconds"
}
}

  3. Use the Click to test the authentication button to test the connection.

Set up the Payload custom-action-aep-payload

  1. In the Request and Response fields, paste the payload from the source connection used before.

    code language-none 
    {
"xdmMeta": {
"schemaRef": {
"id": "https://ns.adobe.com/<your_org>/schemas/<schema_id>",
"contentType": "application/vnd.adobe.xed-full+json;version=1.0"
}
},
"xdmEntity": {
"_id": "/uri-reference",
"<your_org>": {
"journeyVersionId": "Sample value",
"nodeId": "Sample value",
"customer_Id":""
},
"eventMergeId": "Sample value",
"eventType": "advertising.completes,
"producedBy": "self",
"timestamp": "2018-11-12T20:20:39+00:00"
}
}

  2. Change the Field Configuration from Constant to Variable for fields which will be populated dynamically.

  3. Save the Custom Action.

Journey

  1. Finally, use this custom action in a journey to write the custom journey events.

  2. Populate the Journey Version Id, Node Id, Node Name and other attributes according to your use case.

recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76