Zendesk

How to configure a Zendesk connection

This document describes the Dataworkz connector configuration required to access Zendesk.

Prerequisite

Before configuring Dataworkz for Zendesk, create a Connected App in Zendesk. Follow the steps below to create an OAuth app in Zendesk for Dataworkz.

1. Follow these documents to set up the Zendesk connected app and configure OAuth2:

   • https://developer.zendesk.com/api-reference/apps/introduction/

   • https://support.zendesk.com/hc/en-us/articles/4408845965210-Using-OAuth-authentication-with-your-application

2. Keep the following in mind:

   • The Callback URL can be found in Dataworkz UI (see Connecting to Zendesk for details).

   • Add the necessary permissions and scopes for the Zendesk API. Zendesk defines two scopes: Read and Write. Only the Read scope is required to read entity data.

3. Record the Client ID and Secret. These are required when creating the connector in Dataworkz.

Creating Zendesk Configuration in Dataworkz

1. Log in to the Dataworkz application.

2. Go to Configuration > SaaS Applications > Zendesk.

3. Click the + icon to add a new configuration.

1. Enter a name for the Zendesk connector configuration.

2. Select the Zendesk App option:

   1. Zendesk Sell (for Zendesk CRM data)

   2. Zendesk Support (for Zendesk support tickets and other support entities)

3. Select the OAuth option:

   1. Private connection

   2. Dataworkz OAuth

   3. API Key

4. If the authentication type is Private Connected App:

   1. Select Yes if the app has already been created.

   2. Select No. A screen with the redirect URL appears. Copy the redirect URL and go to the Prerequisite section.

5. Select the Workspace to use.

6. Select the Collection to use.

7. Select the Scope for the Zendesk connection.

8. Click Save. Dataworkz prompts you to log in to Zendesk and authorize access to the Zendesk APIs.

The newly created connector appears in the list of Zendesk configurations.

Add Task Configuration

Click the newly created connector, then click the + icon to add a new task configuration for Zendesk.

1. Enter a name for the dataset.

2. Select the Zendesk entity to access.

3. Select the fields of that entity to read.

4. Select the appropriate option for reading all historical data or a date range.

5. Select the incremental pull criteria:

   • Created At

   • Updated At

6. Enable or disable the Recurring Job toggle.

7. Click Add to save the configuration.

This completes the Dataworkz configuration for Zendesk.