UI attributes

UI attributes define the visual elements that Adobe should display for your destination card in the Adobe Experience Platform user interface, such as a logo, a link to the documentation page, a destination description and its category and type.

To understand where this component fits into an integration created with Destination SDK, see the diagram in the configuration options documentation or see the following destination configuration overview pages:

When creating a destination through Destination SDK, the uiAttributes section defines the following visual properties of your destination card:

  • The URL of your destination documentation page in the destination catalog.
  • The category under which your destination will be visible in the Platform UI.
  • The data export frequency for your destination.
  • The destination connection type, such as Amazon S3, Azure Blob, etc.
  • The URL where you hosted the icon to be displayed in the destinations catalog card.

You can configure UI attributes via the /authoring/destinations endpoint. See the following API reference pages for detailed API call examples where you can configure the components shown in this page.

This article describes all the supported UI attributes that you can use for your destination, and shows what customers will see in the Experience Platform UI.

UI screenshot showing the UI attributes in the Experience Platform interface

All parameter names and values supported by Destination SDK are case sensitive. To avoid case sensitivity errors, please use the parameters names and values exactly as shown in the documentation.

Supported integration types supported-integration-types

Refer to the table below for details on which types of integrations support the functionality described on this page.

Integration type
Supports functionality
Real-time (streaming) integrations
File-based (batch) integrations

Supported parameters supported-parameters


documentationLink is a string parameter that refers to the documentation page in the Destinations Catalog for your destination. Every productized destination in Adobe Experience Platform must have a corresponding documentation page. Learn how to create a destination documentation page for your destination. Note that this is not required for private/custom destinations.

Use the following format: http://www.adobe.com/go/destinations-YOURDESTINATION-en, where YOURDESTINATION is the name of your destination. For a destination called Moviestar, you would use http://www.adobe.com/go/destinations-moviestar-en.

Users can see and visit your documentation link from the destinations catalog page in the UI. They need to browse to your destination card, then select More actions, and then View documentation, as shown in the image below.

UI image showing the documentation link location.

This link works only after Adobe sets your destination live and the documentation is published.

category category

category is a string parameter that refers to the category assigned to your destination in Adobe Experience Platform. For more information, read Destination Categories. Use one of the following values: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.

Users can see the list of destination categories on the left side of the screen in the destination catalog, as shown in the image below.

UI image showing the destination category location.

connectionType connection-type

connectionType is a string parameter that refers to the type of connection, depending on the destination. Supported values:

  • Server-to-server
  • Cloud storage
  • Azure Blob
  • Azure Data Lake Storage
  • S3
  • SFTP
  • DLZ

Users can see the destination connection type in the Browse tab of the destinations workspace.

UI image showing the connection type location in the UI.

frequency frequency

frequency is a string parameter that refers to the type of data export supported by your destination. Set to Streaming for API-based integrations, or Batch when you export files to your destinations.

Users can see the frequency type in the Dataflow runs page of each destination connection.

UI image showing the frequency type location in the UI.

isBeta isbeta

If the destination that you are creating with Destination SDK will be available to a limited number of customers, you might want to mark the destination card from the destination catalog as beta.

To do this, you can use the isBeta: "true" parameter in the UI attributes section of the destination configuration to mark the destination card appropriately.

UI image showing a destination card marked as beta.

icon icon

You can add a logo icon to your destination, as shown in the image below.

UI image showing the icon location.

To add a logo to your destination card, you need to share the desired image with the Adobe team when you submit the destination for review.

Next steps next-steps

After reading this article, you should have a better understanding of which UI attributes you can configure for your destination and where the users will see them in the Platform UI.

To learn more about the other destination components, see the following articles: