How to read data from Zendesk in SSIS (Export data)

In this section we will learn how to configure and use Zendesk Connector in the API Source to extract data from the Zendesk.

1. Begin with opening Visual Studio and Create a New Project.

2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

3. In the the new SSIS project screen you will find the following:

   1. SSIS ToolBox on left side bar
   2. Solution Explorer and Property Window on right bar
   3. Control flow, data flow, event Handlers, Package Explorer in tab windows
   4. Connection Manager Window in the bottom
   
   Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
   

5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
   

6. Select New Connection to create a new connection:
   

7. Use a preinstalled Zendesk Connector from Popular Connector List or press Search Online radio button to download Zendesk Connector. Once downloaded simply use it in the configuration:
   

   Zendesk

   

8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Token Authentication [Http]

   Authenticate using Static Token instead of userid / password ([Token Access] option must be enabled under Admin Console > Channel > API > Settings and then Click [ADD API Token] to generate new token. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [API Help..]

   Please refer to below API Reference (External Site) link for Token Authentication [Http]

   https://developer.zendesk.com/rest_api/docs/support/introduction#api-token

   Zendesk

   Token Authentication [Http]

   https://[$Domain$].zendesk.com/api/v2

   Required Parameters
   Sub Domain (e.g. mycompany)	Fill in the parameter...
   UserId	Fill in the parameter...
   Token	Fill in the parameter...
   Optional Parameters
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

    OAuth Authentication [OAuth]

   OAuth App must be created under Admin Console > Channel > API > Settings. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/oauth_clients [API Help..]

   Please refer to below API Reference (External Site) link for OAuth Authentication [OAuth]

   https://developer.zendesk.com/rest_api/docs/support/introduction#oauth-access-token

   Zendesk

   OAuth Authentication [OAuth]

   https://[$Domain$].zendesk.com/api/v2

   Required Parameters
   Sub Domain (e.g. mycompany)	Fill in the parameter...
   ClientId	Fill in the parameter...
   ClientSecret	Fill in the parameter...
   Permissions	Fill in the parameter...
   RedirectUrl	Fill in the parameter...
   Optional Parameters
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

    UserID/Password Authentication (2FA must be OFF) [Http]

   Authenticate using your userid / password (2FA must be OFF and [Password Access] option must be enabled under Admin Console > Channel > API > Settings. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [API Help..]

   Please refer to below API Reference (External Site) link for UserID/Password Authentication (2FA must be OFF) [Http]

   https://developer.zendesk.com/rest_api/docs/support/introduction#basic-authentication.

   Zendesk

   UserID/Password Authentication (2FA must be OFF) [Http]

   https://[$Domain$].zendesk.com/api/v2

   Required Parameters
   Sub Domain (e.g. mycompany)	Fill in the parameter...
   UserName (2FA Must be OFF)	Fill in the parameter...
   Password	Fill in the parameter...
   Optional Parameters
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

   API Source - Zendesk

   Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.

   

10. That's it; we are done. In a few clicks we configured the call to Zendesk using ZappySys Zendesk Connector