Zendesk Connector for Azure Data Factory (Pipeline)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. In this article you will learn how to quickly and efficiently integrate Zendesk data in Azure Data Factory (Pipeline) without coding. We will use high-performance Zendesk Connector to easily connect to Zendesk and then access the data inside Azure Data Factory (Pipeline). Let's follow the steps below to see how we can accomplish that! Zendesk Connector for Azure Data Factory (Pipeline) is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Zendesk in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Zendesk using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from Zendesk. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN. -
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Zendesk" from the list of Popular Connectors. If "Zendesk" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ZendeskDSNZendesk -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
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 reference]
Please refer to below API reference (external site) link for Token Authentication [Http]https://developer.zendesk.com/rest_api/docs/support/introduction#api-token
Fill in all required parameters and set optional parameters if needed:
ZendeskDSNZendeskToken Authentication [Http]https://[$Domain$].zendesk.com/api/v2Required Parameters Sub Domain (e.g. mycompany) Fill-in the parameter... UserId Fill-in the parameter... Token Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True 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 reference]
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
Fill in all required parameters and set optional parameters if needed:
ZendeskDSNZendeskOAuth Authentication [OAuth]https://[$Domain$].zendesk.com/api/v2Required 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 RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True 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 reference]
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.
Fill in all required parameters and set optional parameters if needed:
ZendeskDSNZendeskUserID/Password Authentication (2FA must be OFF) [Http]https://[$Domain$].zendesk.com/api/v2Required 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 RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ZendeskZendesk 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.ZendeskDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Azure Data Factory (Pipeline) to retrieve data from Zendesk. Hit OK button to use this query in the next step.
SELECT * FROM Tickets
Some parameters configured in this window will be passed to the Zendesk API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Azure Data Factory (Pipeline):
ZappySys API Driver - ZendeskZendesk 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.ZendeskDSNSELECT * FROM Tickets
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Zendesk API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Zendesk servers). -
Click OK to finish creating the data source.
Video Tutorial
Read data in Azure Data Factory (ADF) from ODBC datasource (Zendesk)
-
To start press New button:
-
Select "Azure, Self-Hosted" option:
-
Select "Self-Hosted" option:
-
Set a name, we will use "OnPremisesRuntime":
-
Download and install Microsoft Integration Runtime.
-
Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:
-
After finishing registering the Integration Runtime node, you should see a similar view:
-
Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:
-
Go to Linked services section and create a new Linked service based on ODBC:
-
Select "ODBC" service:
-
Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:
ZendeskDSNDSN=ZendeskDSN -
For created ODBC service create ODBC-based dataset:
-
Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:
-
Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:
-
Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:
Actions supported by Zendesk Connector
Learn how to perform common Zendesk actions directly in Azure Data Factory (Pipeline) with these how-to guides:
- Create Organization
- Create Ticket (Single)
- Create Tickets (Bulk)
- Create User
- Delete Attachment
- Delete Organization
- Delete Ticket
- Delete Tickets (Bulk)
- Delete Upload Session
- Delete User
- Read Attachment
- Read Brands
- Read Current User Info
- Read Groups
- Read Macros
- Read Organization Count
- Read Organization Fields
- Read Organization(s) by ID
- Read Organizations (All)
- Read Organizations (Incremental) changed after a specified date
- Read Requests
- Read Requests Search
- Read Sessions
- Read Tags
- Read Ticket ActivityStream
- Read Ticket ActivityStream Details
- Read Ticket Attachments
- Read Ticket Comments
- Read Ticket Events (Incremental) changed after a specified date
- Read Ticket Fields
- Read Ticket Forms
- Read Ticket Metric Events (Incremental) changed after a specified date
- Read Ticket Metrics
- Read Ticket(s) by ID
- Read Tickets (All)
- Read Tickets (Incremental) changed after a specified date
- Read Tickets (Recent)
- Read Tickets Count (All)
- Read Tickets Count (for Organization)
- Read Tickets for Organization
- Read Tickets for User (Assigned)
- Read Tickets for User (CCed)
- Read Tickets for User (Requested)
- Read User Fields
- Read User Sessions
- Read User(s) by ID
- Read Users (All)
- Read Users (Incremental) changed after a specified date
- Read Views
- Search Records - NO Sorting (Allows more than 1000 rows)
- Search Records - WITH Sorting and Extra Columns (Max 1000 rows)
- Update Organization
- Update Ticket (Single)
- Update Tickets (Bulk)
- Update User
- Upload Attachment (Single file)
- Upsert Organization - Create or Update
- Upsert User - Create or Update
- Upsert Users (Bulk) - Create or Update
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Zendesk in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Zendesk, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Zendesk Connector for Azure Data Factory (Pipeline) and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Zendesk Connector for Azure Data Factory (Pipeline) Documentation
More integrations
Other connectors for Azure Data Factory (Pipeline)
Other application integration scenarios for Zendesk
How to connect Zendesk in Azure Data Factory (Pipeline)?
How to get Zendesk data in Azure Data Factory (Pipeline)?
How to read Zendesk data in Azure Data Factory (Pipeline)?
How to load Zendesk data in Azure Data Factory (Pipeline)?
How to import Zendesk data in Azure Data Factory (Pipeline)?
How to pull Zendesk data in Azure Data Factory (Pipeline)?
How to push data to Zendesk in Azure Data Factory (Pipeline)?
How to write data to Zendesk in Azure Data Factory (Pipeline)?
How to POST data to Zendesk in Azure Data Factory (Pipeline)?
Call Zendesk API in Azure Data Factory (Pipeline)
Consume Zendesk API in Azure Data Factory (Pipeline)
Zendesk Azure Data Factory (Pipeline) Automate
Zendesk Azure Data Factory (Pipeline) Integration
Integration Zendesk in Azure Data Factory (Pipeline)
Consume real-time Zendesk data in Azure Data Factory (Pipeline)
Consume real-time Zendesk API data in Azure Data Factory (Pipeline)
Zendesk ODBC Driver | ODBC Driver for Zendesk | ODBC Zendesk Driver | SSIS Zendesk Source | SSIS Zendesk Destination
Connect Zendesk in Azure Data Factory (Pipeline)
Load Zendesk in Azure Data Factory (Pipeline)
Load Zendesk data in Azure Data Factory (Pipeline)
Read Zendesk data in Azure Data Factory (Pipeline)
Zendesk API Call in Azure Data Factory (Pipeline)