Zendesk

How to configure a Zendesk connection

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

Prerequisite

Before configuring Dataworkz for Zendesk, a "Connected App" needs to be configured in Zendesk. Follow the steps listed below for creating an OAuth App in Zendesk for Dataworkz.

1. Follow these documents to setup Zendesk connected app and to 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 in mind the following points while doing the same.

   • Callback URL can be found in Dataworkz UI (Refer Connecting to Zendesk section for details)

   • Permissions/scopes need to be added for Zendesk API. There are 2 scopes defined for Zendesk i.e. Read and write. Only read scope is required to read entities data.

3. Make note of the Client ID & Secret. These details would be required at the time of creating the connector in Dataworkz.

Creating Zendesk configuration in Dataworkz

1. Login to Dataworkz Application

2. Goto Configuration -> SaaS Applications -> Zendesk

3. Click the + icon to add a new configuration

4. 
5. Enter the name of Zendesk connector configuration

6. Select Zendesk App option

   1. Zendesk Sell (to get zendesk CRM data)

   2. Zendesk Support (to get Zendesk support tickets and other support entities).

7. Select the OAuth Option

   1. Private connection

   2. Dataworkz OAuth

   3. Api Key

8. If selected authentication type is Private Connected App then

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

   2. Select "No". Screen with the redirect URL would pop-up. Copy the redirect URL and goto Prerequisite section.

      
9. Choose the workspace that you want to use

10. Choose the collection that you would like to use

11. Choose the scope for the Zendesk connection

12. Save the configuration. This would prompt you to login to Zendesk account and authorize Dataworkz to access Zendesk APIs

13. Newly created connector would show up in the list of Zendesk configurations.

Add Task Configuration

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

1. Enter name for the dataset

2. Select the Zendesk entity that you need to access

3. Select the fields of the entity that need to be read

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

5. Select the incremental pull criteria

   • Created At

   • Updated At

6. Enable/disable recurring job

7. Click Add to save the configuration

This would complete the Dataworkz configuration for Zendesk