ÃÛ¶¹ÊÓƵ

2.3.6 Destinations SDK

Setup your ÃÛ¶¹ÊÓƵ I/O project

In this exercise you’ll be using ÃÛ¶¹ÊÓƵ I/O again to query ÃÛ¶¹ÊÓƵ Experience Platform’s API’s. If you haven’t configured your ÃÛ¶¹ÊÓƵ I/O project yet, go back to Exercise 3 in Module 2.1 and follow the instructions there.

Authentication to ÃÛ¶¹ÊÓƵ I/O

In this exercise you’ll be using Postman again to query ÃÛ¶¹ÊÓƵ Experience Platform’s API’s. If you haven’t configured your Postman application yet, go back to Exercise 3 in Module 2.1 and follow the instructions there.

Define endpoint and format

For this exercise, you’ll need an endpoint to configure so that when an audience qualifies, the qualification event can be streamed to that endpoint. In this exercise, you’ll use a sample endpoint using . Go to , create an account and then create a workspace. Once the workspace is created, you’ll see something similar to this.

Click copy to copy the url. You’ll need to specify this url in the next exercise. The URL in this example is https://eodts05snjmjz67.m.pipedream.net.

As for the format, we’ll use a standard template that will stream audience qualifications or unqualifications along with metadata like customer identifiers. Templates can be customized to meet the expectations of specific endpoints, but in this exercise we’ll reuse a standard template, which will result in a payload like this that will be streamed to the endpoint.

{
  "profiles": [
    {
      "identities": [
        {
          "type": "ecid",
          "id": "64626768309422151580190219823409897678"
        }
      ],
      "ÃÛ¶¹ÊÓƵExperiencePlatformSegments": {
        "add": [
          "f58c723c-f1e5-40dd-8c79-7bb4ab47f041"
        ],
        "remove": []
      }
    }
  ]
}

Create a server and template configuration

The first step to create your own Destination in ÃÛ¶¹ÊÓƵ Experience Platform is to create a server and template configuration using Postman.

To do that, open your Postman application and go to Destination Authoring API, to Destination servers and templates and click to open the request POST - Create a destination server configuration.

You’ll then see this. Under Headers, you need to manually update the value for the key x-sandbox-name and set it to --aepSandboxName--. Select the value {{SANDBOX_NAME}}.

Replace it by --aepSandboxName--.

Next, go to Body. select the placeholder {{body}}.

You now need to replace the placeholder {{body}} by the below code:

{
    "name": "Custom HTTP Destination",
    "destinationServerType": "URL_BASED",
    "urlBasedDestination": {
        "url": {
            "templatingStrategy": "PEBBLE_V1",
            "value": "yourURL"
        }
    },
    "httpTemplate": {
        "httpMethod": "POST",
        "requestBody": {
            "templatingStrategy": "PEBBLE_V1",
            "value": "{\n    \"profiles\": [\n    {%- for profile in input.profiles %}\n        {\n            \"identities\": [\n            {%- for idMapEntry in profile.identityMap -%}\n            {%- set namespace = idMapEntry.key -%}\n                {%- for identity in idMapEntry.value %}\n                {\n                    \"type\": \"{{ namespace }}\",\n                    \"id\": \"{{ identity.id }}\"\n                }{%- if not loop.last -%},{%- endif -%}\n                {%- endfor -%}{%- if not loop.last -%},{%- endif -%}\n            {% endfor %}\n            ],\n            \"ÃÛ¶¹ÊÓƵExperiencePlatformSegments\": {\n                \"add\": [\n                {%- for segment in profile.segmentMembership.ups | added %}\n                    \"{{ segment.key }}\"{%- if not loop.last -%},{%- endif -%}\n                {% endfor %}\n                ],\n                \"remove\": [\n                {#- Alternative syntax for filtering segments by status: -#}\n                {% for segment in removedSegments(profile.segmentMembership.ups) %}\n                    \"{{ segment.key }}\"{%- if not loop.last -%},{%- endif -%}\n                {% endfor %}\n                ]\n            }\n        }{%- if not loop.last -%},{%- endif -%}\n    {% endfor %}\n    ]\n}"
        },
        "contentType": "application/json"
    }
}

After pasting the above code, you need to manually update the field urlBasedDestination.url.value, and you need to set it to the url of the webhook you created in the previous step, which was https://eodts05snjmjz67.m.pipedream.net in this example.

After updating the field urlBasedDestination.url.value, it should look like this. Click Send.

After clicking Send, your server template will be created, and as part of the response you’ll see a field named instanceId. Write it down, as you’ll need it in the next step. In this example, the instanceId is
52482c90-8a1e-42fc-b729-7f0252e5cebd.

Create your destination configuration

In Postman, under Destination Authoring API, go to Destination configurations and click to open the request POST - Create a destination configuration. You’ll then see this. Under Headers, you need to manually update the value for the key x-sandbox-name and set it to --aepSandboxName--. Select the value {{SANDBOX_NAME}} and replace it by --aepSandboxName--.

Next, go to Body. select the placeholder {{body}}.

You now need to replace the placeholder {{body}} by the below code:

{
    "name": "--aepUserLdap-- - Webhook",
    "description": "Exports segment qualifications and identities to a custom webhook via Destination SDK.",
    "status": "TEST",
    "customerAuthenticationConfigurations": [
        {
            "authType": "BEARER"
        }
    ],
    "customerDataFields": [
        {
            "name": "endpointsInstance",
            "type": "string",
            "title": "Select Endpoint",
            "description": "We could manage several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
            "isRequired": true,
            "enum": [
                "US",
                "EU",
                "APAC",
                "NZ"
            ]
        }
    ],
    "uiAttributes": {
        "documentationLink": "/docs/experience-platform/destinations/home.html?lang=en",
        "category": "streaming",
        "connectionType": "Server-to-server",
        "frequency": "Streaming"
    },
    "identityNamespaces": {
        "ecid": {
            "acceptsAttributes": true,
            "acceptsCustomNamespaces": false
        }
    },
    "segmentMappingConfig": {
        "mapExperiencePlatformSegmentName": true,
        "mapExperiencePlatformSegmentId": true,
        "mapUserInput": false
    },
    "aggregation": {
        "aggregationType": "BEST_EFFORT",
        "bestEffortAggregation": {
            "maxUsersPerRequest": "1000",
            "splitUserById": false
        }
    },
    "schemaConfig": {
        "profileRequired": false,
        "segmentRequired": true,
        "identityRequired": true
    },
    "destinationDelivery": [
        {
            "authenticationRule": "NONE",
            "destinationServerId": "yourTemplateInstanceID"
        }
    ]
}

After pasting the above code, you need to manually update the field destinationDelivery. destinationServerId, and you need to set it to the instanceId of the destination server template you created in the previous step, which was 52482c90-8a1e-42fc-b729-7f0252e5cebd in this example. Next, cick Send.

You’ll then see this response.

Your destination is now created in ÃÛ¶¹ÊÓƵ Experience Platform. Let’s go there and check it.

Go to . After logging in, you’ll land on the homepage of ÃÛ¶¹ÊÓƵ Experience Platform.

Before you continue, you need to select a sandbox. The sandbox to select is named --aepSandboxName--. After selecting the appropriate sandbox, you’ll see the screen change and now you’re in your dedicated sandbox.

In the left menu, go to Destinations, click Catalog and scroll down to the category Streaming. You’ll see your destination avaiable there now.

Link your audience to your destination

In Destinations > Catalog, click Set up on your destination to start adding audiences to your new destination.

Enter a random value for the bearer token, like 1234. Click Connect to destination.

You’ll then see this. As a name for your destination, use --aepUserLdap-- - Webhook. Select an endpoint of choice, in this example EU. Click Next.

You can optionally select a data governance policy. Click Next.

Select the audience you created earlier, which is named --aepUserLdap-- - Interest in Galaxy S24. Click Next.

You’ll then see this. Make sure to map the SOURCE FIELD --aepTenantId--.identification.core.ecid to the field Identity: ecid. Click Next.

Click Finish.

Your destination is now live, new audience qualifications will be streamed to your custom webhook now.

Test your audience activation

Go to . After logging in with your ÃÛ¶¹ÊÓƵ ID, you’ll see this. Click the 3 dots … on your website project and then click Run to open it.

You’ll then see your demo website open up. Select the URL and copy it to your clipboard.

Open a new incognito browser window.

Paste the URL of your demo website, which you copied in the previous step. You’ll then be asked to login using your ÃÛ¶¹ÊÓƵ ID.

Select your account type and complete the login process.

You’ll then see your website loaded in an incognito browser window. For every exercise, you’ll need to use a fresh, incognito browser window to load your demo website URL.

In this example, you want to respond to a specific customer viewing a specific product.
From the Citi Signal homepage, go to Phones & devices, and click the product Galaxy S24.

The product page for Galaxy S24 has now been viewed, so your audience will qualify for your profile in the following minutes.

When you open the Profile Viewer, and go to Audiences, you’ll see the audience qualify.

Now go back to your open webhook on , where you should see a new incoming request, which originates from ÃÛ¶¹ÊÓƵ Experience Platform and which contains the audience qualification event.

Next Step: Summary and benefits

Go Back to Module 2.3

Go Back to All Modules