Destination delivery
To offer more control over where the data exported to your destination lands, Destination SDK allows you to specify destination delivery settings.
The destination delivery section indicates where the exported data goes and what authentication rule is used in the location where the data will land.
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:
You can configure destination delivery settings 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 destination delivery options that you can use for your destination.
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.
Supported parameters supported-parameters
When configuring your destination delivery settings, you can use the parameters described in the table below to define where the exported data should be sent.
authenticationRuleIndicates how Platform should connect to your destination. Supported values:
CUSTOMER_AUTHENTICATION: Use this option if Platform customers log in to your system via any of the authentication methods described here.PLATFORM_AUTHENTICATION: Use this option if there is a global authentication system between ÃÛ¶¹ÊÓƵ and your destination and the Platform customer does not need to provide any authentication credentials to connect to your destination. In this case, you must create a credentials object using the credentials API configuration.NONE: Use this option if no authentication is required to send data to your destination platform.
destinationServerIdinstanceId of the destination server that you want to export data to.deliveryMatchers.type- When configuring destination delivery for file-based destinations, always set this to
SOURCE. - When configuring destination delivery for a streaming destination, the
deliveryMatcherssection is not required.
deliveryMatchers.value- When configuring destination delivery for file-based destinations, always set this to
batch. - When configuring destination delivery for a streaming destination, the
deliveryMatcherssection is not required.
Destination delivery settings for streaming destinations destination-delivery-streaming
The example below shows how the destination delivery settings should be configured for a streaming destination. Note that the deliveryMatchers section is not required for streaming destinations.
{
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{destinationServerId}}"
}
]
}
Destination delivery settings for file-based destinations destination-delivery-file-based
The example below shows how the destination delivery settings should be configured for a file-based destination. Note that the deliveryMatchers section is required for file-based destinations.
{
"destinationDelivery":[
{
"deliveryMatchers":[
{
"type":"SOURCE",
"value":[
"batch"
]
}
],
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{destinationServerId}}"
}
]
}
Next steps next-steps
After reading this article, you should have a better understanding of how you can configure the locations where your destination should export data, for both streaming and file-based destinations.
To learn more about the other destination components, see the following articles: