Create a Zendesk source connection in the UI

Last update: 2023-06-12
  • Topics:
  • Sources
    View more on this topic
  • Created for:
  • Developer

This tutorial provides steps for creating a Zendesk source connection using the Adobe Experience Platform user interface.

Getting started

This tutorial requires a working understanding of the following components of Adobe Experience Platform:

Gather required credentials

In order to access your Zendesk account on Platform, you must provide values for the following credentials:

Credential Description Example
Subdomain The unique domain specific to your account created during the registration process. yoursubdomain
Access token Zendesk API token. 0lZnClEvkJSTQ7olGLl7PMhVq99gu26GTbJtf

For more information on authenticating your Zendesk source, see the Zendesk source overview.

Zendesk API token

Create a Platform schema for Zendesk

Before creating a Zendesk source connection, you must also ensure that you first create a Platform schema to use for your source. See the tutorial on creating a Platform schema for comprehensive steps on how to create a schema.

For additional guidance on your Zendesk schema required for the Zendesk Search API, refer to the limits section below.

Create Schema

Connect your Zendesk account

In the Platform UI, select Sources from the left navigation bar to access the Sources workspace. The Catalog screen displays a variety of sources with which you can create an account.

You can select the appropriate category from the catalog on the left-hand side of your screen. Alternatively, you can find the specific source you wish to work with using the search option.

Under the Customer Success category, select Zendesk, and then select Add data.


The Connect Zendesk account page appears. On this page, you can either use new credentials or existing credentials.

Existing account

To use an existing account, select the Zendesk account you want to create a new dataflow with, then select Next to proceed.


New account

If you are creating a new account, select New account, and then provide a name, an optional description, and your credentials. When finished, select Connect to source and then allow some time for the new connection to establish.


Select data

Once your source is authenticated, the page updates into an interactive schema tree that allows you to explore and inspect the hierarchy of your data. Select Next to proceed.


Next steps

By following this tutorial, you have authenticated and created a source connection between your Zendesk account and Platform. You can now continue on to the next tutorial and create a dataflow to bring customer success data into Platform.

Additional resources

The sections below provides additional resources that you can refer to when using the Zendesk source.


The following outlines steps you can take to validate that you have successfully connected your Zendesk source and that Zendesk profiles are being ingested to Platform.

In the Platform UI, select Datasets from the left navigation to access the Datasets workspace. The Dataset Activity screen displays the details of executions.

Activity page

Next, select the dataflow run ID of the dataflow that you want to view to see specific details about that dataflow run.

Dataflow page

Finally, select Preview dataset to display the data that was ingested.

Zendesk dataset

You can also verify your Platform data against the data on your Zendesk > Customers page.


Zendesk schema

The table below lists the supported mappings that must be set up for Zendesk.


See Zendesk Search API > Export Search Results for more information on the API.

Source Type Boolean
results.alias String
results.created_at String
results.custom_role_id Integer
results.default_group_id Integer
results.details String String
results.external_id Integer
results.iana_time_zone String Integer
results.last_login_at String
results.locale String
results.locale_id Integer
results.moderator Boolean String
results.notes String
results.only_private_comments Boolean
results.organization_id Integer String String
results.report_csv Boolean
results.restricted_agent Boolean
results.result_type String
results.role String
results.role_type Integer
results.shared Boolean
results.shared_agent Boolean
results.shared_phone_number Boolean
results.signature String
results.suspended Boolean
results.ticket_restriction String
results.time_zone String
results.two_factor_auth_enabled Boolean
results.updated_at String
results.url String
results.verified Boolean


On this page