Create a destination configuration
This page exemplifies the API request and payload that you can use to create your own destination configuration, using the /authoring/destinations
API endpoint.
For a detailed description of the capabilities that you can configure through this endpoint, read the following articles:
- Customer authentication configuration
- OAuth2 authorization
- Customer data fields
- UI attributes
- Schema configuration
- Identity namespace configuration
- Destination delivery
- Audience metadata configuration
- Audience metadata configuration
- Aggregation policy
- Batch configuration
- Historical profile qualifications
Getting started with destination configuration API operations get-started
Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including how to obtain the required destination authoring permission and required headers.
Create a destination configuration create
You can create a new destination configuration by making a POST request to the /authoring/destinations
endpoint.
platform.adobe.io/data/core/activation/authoring/destinations
API format
POST /authoring/destinations
The following request creates a new Amazon S3 destination configuration, configured by the parameters provided in the payload. The payload below includes all parameters for file-based destinations accepted by the /authoring/destinations
endpoint.
Note that you do not have to add all parameters to your API call, and that the payload is customizable, according to your API requirements.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 19-row-3 20-row-3 21-row-3 22-row-3 23-row-3 24-row-3 25-row-3 26-row-3 27-row-3 28-row-3 29-row-3 30-row-3 31-row-3 layout-auto | ||||
---|---|---|---|---|
Parameter | Type | Description | ||
name |
String | Indicates the title of your destination in the Experience Platform catalog. | ||
description |
String |
Provide a description that Adobe will use in the Experience Platform destinations catalog for your destination card. Aim for no more than 4-5 sentences.+-------------------------------------------------------------------+ | img-md |
|
||
status |
String | Indicates the lifecycle status of the destination card. Accepted values are TEST , PUBLISHED , and DELETED . Use TEST when you first configure your destination. |
||
customerAuthenticationConfigurations.authType |
String | Indicates the configuration used to authenticate Experience Platform customers to your destination server. See customer authentication configuration for detailed information about the supported authentication types. | ||
customerDataFields.name |
String |
Provide a name for the custom field you are introducing.
|
||
customerDataFields.type |
String | Indicates what type of custom field you are introducing. Accepted values are string , object , integer .See Customer data fields for detailed information about these settings. |
||
customerDataFields.title |
String | Indicates the name of the field, as it is seen by customers in the Experience Platform user interface. See Customer data fields for detailed information about these settings. |
||
customerDataFields.description |
String | Provide a description for the custom field. See Customer data fields for detailed information about these settings. | ||
customerDataFields.isRequired |
Boolean | Indicates if this field is required in the destination setup workflow. See Customer data fields for detailed information about these settings. |
||
customerDataFields.enum |
String | Renders the custom field as a dropdown menu and lists the options available to the user. See Customer data fields for detailed information about these settings. |
||
customerDataFields.default |
String | Defines the default value from an enum list. |
||
customerDataFields.pattern |
String | Enforces a pattern for the custom field, if needed. Use regular expressions to enforce a pattern. For example, if your customer IDs don’t include numbers or underscores, enter ^[A-Za-z]+$ in this field.See Customer data fields for detailed information about these settings. |
||
uiAttributes.documentationLink |
String |
Refers to the documentation page in the Destinations Catalog for your destination. Use
|
||
uiAttributes.category |
String | 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 .See UI attributes for detailed information about these settings. |
||
uiAttributes.connectionType |
String |
The type of connection, depending on the destination. Supported values:
|
||
uiAttributes.frequency |
String | Refers to the type of data export supported by the destination. Set to Streaming for API-based integrations, or Batch when you export files to your destinations. |
||
identityNamespaces.externalId.acceptsAttributes |
Boolean | Indicates if customers can map standard profile attributes to the identity that you are configuring. | ||
identityNamespaces.externalId.acceptsCustomNamespaces |
Boolean | Indicates if customers can map identities belonging to custom namespaces to the identity that you are configuring. | ||
identityNamespaces.externalId.transformation |
String | Not shown in example configuration. Used, for example, when the Platform customer has plain email addresses as an attribute and your platform only accepts hashed emails. This is where you would provide the transformation that needs to be applied (for example, transform the email to lowercase, then hash). | ||
identityNamespaces.externalId.acceptedGlobalNamespaces |
- | Indicates which standard identity namespaces (for example, IDFA) customers can map to the identity that you are configuring. When you use acceptedGlobalNamespaces , you can use "requiredTransformation":"sha256(lower($))" to lowercase and hash email addresses or phone numbers. |
||
destinationDelivery.authenticationRule |
String |
Indicates how Platform customers connect to your destination. Accepted values are
|
||
destinationDelivery.destinationServerId |
String | The instanceId of the destination server template used for this destination. |
||
backfillHistoricalProfileData |
Boolean | Controls whether historical profile data is exported when audiences are activated to the destination. Always set this to true . |
||
segmentMappingConfig.mapUserInput |
Boolean | Controls whether the audience mapping ID in the destination activation workflow is input by user. | ||
segmentMappingConfig.mapExperiencePlatformSegmentId |
Boolean | Controls whether the audience mapping ID in the destination activation workflow is the Experience Platform audience ID. | ||
segmentMappingConfig.mapExperiencePlatformSegmentName |
Boolean | Controls whether the audience mapping ID in the destination activation workflow is the Experience Platform audience name. | ||
segmentMappingConfig.audienceTemplateId |
Boolean | The instanceId of the audience metadata template used for this destination. |
||
schemaConfig.profileFields |
Array | When you add predefined profileFields as shown in the configuration above, users will have the option of mapping Experience Platform attributes to the predefined attributes on your destination’s side. |
||
schemaConfig.profileRequired |
Boolean | Use true if users should be able to map profile attributes from Experience Platform to custom attributes on your destination’s side, as shown in the example configuration above. |
||
schemaConfig.segmentRequired |
Boolean | Always use segmentRequired:true . |
||
schemaConfig.identityRequired |
Boolean | Use true if you users should be able to map identity namespaces from Experience Platform to your desired schema. |
API error handling
Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide.
Next steps
After reading this document, you now know how to create a new destination configuration through the Destination SDK /authoring/destinations
API endpoint.
To learn more about what you can do with this endpoint, see the following articles:
To understand where this endpoint fits into the destination authoring process, see the following articles: