Connect Zendesk to Experience Platform using the Flow Service API

The following tutorial walks you through the steps to create a Zendesk source connection and create a dataflow to bring Zendesk data to Experience Platform using the Flow Service API.

Create a base connection

A base connection retains information between your source and Experience Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.

To create a base connection ID, make a POST request to the /connections endpoint while providing your Zendesk authentication credentials as part of the request body.

API format

POST /connections

Request

The following request creates a base connection for Zendesk:

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Zendesk base connection",
        "description": "Zendesk base connection to authenticate to Experience Platform",
        "connectionSpec": {
            "id": "0a27232b-2c6e-4396-b8c6-c9fc24e37ba4",
            "version": "1.0"
        },
        "auth": {
            "specName": "OAuth2 Refresh Code",
            "params": {
                "subdomain": "{SUBDOMAIN}",
                "accessToken": "{ACCESS_TOKEN}"
            }
        }
    }'
PropertyDescription
nameThe name of your base connection. Ensure that the name of your base connection is descriptive as you can use this to look up information on your base connection.
descriptionAn optional value that you can include to provide more information on your base connection.
connectionSpec.idThe connection specification ID of your source. This ID can be retrieved after your source is registered and approved through the Flow Service API.
auth.specNameThe authentication type that you are using to authenticate your source to Experience Platform.
auth.params.Contains the credentials required to authenticate your source.
auth.params.subdomainThe unique domain associated with your account. The format for subdomain is https://yoursubdomain.zendesk.com.
auth.params.accessTokenThe corresponding access token used to authenticate your source. This is required for OAuth-based authentication.

Response

A successful response returns the newly created base connection, including its unique connection identifier (id). This ID is required to explore your source’s file structure and contents in the next step.

{
     "id": "70383d02-2777-4be7-a309-9dd6eea1b46d",
     "etag": "\"d64c8298-add4-4667-9a49-28195b2e2a84\""
}