Configuration options in Destination SDK

Last update: 2023-11-07
  • Created for:
  • Developer
    User
    Admin
    Leader

The destinations service in Adobe Experience Platform uses configuration endpoints for several components that build up the destinations functionality.

Combined, these components allow Experience Platform to connect to destination platforms, send custom messages, export custom files, and activate profile data across the digital ecosystem.

The diagram below shows a high-level overview of the components that you can configure through Destination SDK to build your own destination. These components are described further below.

Diagram showing the Destination SDK components, configuration endpoints, and the operations supported by them.

Server configuration

The destination server configuration ties together information about your server specs and the templating used by Adobe to deliver payloads to your destination.

For example, this is where you specify the API endpoints on your side that Experience Platform needs to connect to as well as the headers and the format of the API calls that Platform will make.

For file-based destinations, this configuration also includes the supported file formatting and compression formats for your destination. You can configure the functionalities described below via the destination-servers endpoint.

  • Server specs: A configuration template that contains information about the storage location or HTTP endpoint where data is sent to.
  • Template specs: In this template, you can define how to structure the HTTP API request to your endpoint, including how to transform profile attribute fields between the XDM schema and the format that your platform supports. Use this information together with the message format documentation.
  • Message format: This section addresses in-depth information about supported templating languages, message formats, and the information required by Adobe to set up the integration with your platform. Use this information together with the template specs documentation.
  • File specs: A configuration template that includes the file formatting and compression options for your batch destination.

Destination configuration

This configuration endpoint contains basic and advanced information about your destination. For example, this is where you specify the identity types that your destination can support, the desired format of exported files (for file-based destinations), and various UI attributes for your destination card in the Adobe Experience Platform user interface.

See the documentation below for details about each of the destination configuration components. You can configure the functionalities described below via the destinations endpoint.

  • Customer authentication configuration: Select the authentication mechanism that Experience Platform should use to connect to your destination. This configuration generates the Configure new destination page in the Experience Platform user interface, where users connect Experience Platform to the accounts they have with your destination.
  • OAuth2 authorization: Learn about all the OAuth2 authentication flows supported by Destination SDK, and get instructions to set up OAuth2 authentication for your destination…
  • Customer data fields: Learn how to create input fields in the Experience Platform UI that allow your users to specify various information relevant to how to connect and export data to your destination.
  • UI attributes: Learn how to configure the UI attributes, such as the documentation link, the destination card category, and the destination connection type and frequency, for destinations built with Destination SDK.
  • Schema configuration: Learn how to define your destination’s target schema to which users can map profile attributes and identities.
  • Identity namespace configuration: Learn how to configure the identities supported by your destination. This configuration populates the target identities in the mapping step of the Experience Platform user interface, where users map identities and attributes from their XDM schemas to the schema in your destination.
  • Destination delivery: Learn how to configure where exactly the exported data goes and what authentication rule is used in the location where the data will land.
  • Audience metadata configuration: Learn how audience metadata like audience names or IDs should be shared between Experience Platform and your destination.
  • Aggregation policy: Learn how to set up an aggregation policy to determine how HTTP requests to your destination should be grouped and batched.
  • Batch configuration: Set up various file naming and export scheduling settings available to users when connecting to your destination in the Experience Platform user interface.
  • Historical profile qualifications: Learn about the historical profile qualifications supported by destinations built with Destination SDK.

Audience metadata configuration

This component allows you to configure how audiences are programmatically created, updated, or deleted in your destination. For file-based destinations, it allows you to set up a notification whenever files are successfully delivered to your destination. You can configure this functionality via the audience-templates endpoint.

Next steps

By reading this article, you now have a general overview of the functionality provided by Destination SDK and which pages to read for more information about specific configurations. Next, you can read the guides which include all the steps to configure a streaming or a file-based destination by using Destination SDK.

On this page