Zendesk Connector for Azure Data Factory (SSIS)
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. You can use this connector to integrate Zendesk data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.
Download
Documentation
If you are new with SSIS and ZappySys SSIS PowerPack then check below links to get started.
|
Connect to Zendesk in other apps
|
Create SSIS package
First of all, create an SSIS package, which will connect to Zendesk in SSIS.
Once you do that, you are one step closer to deploying and running it in Azure-SSIS integration runtime in Azure Data Factory (ADF).
Then simply proceed to the next step - creating and configuring Azure Blob Storage Container.
Prepare custom setup files for Azure-SSIS runtime
Now it's time to start preparing custom setup files for Azure-SSIS runtime.
During Azure-SSIS runtime creation you can instruct ADF to perform a custom setup on a VM (Azure-SSIS node);
i.e. to run the custom installer, copy files, execute PowerShell scripts, etc.
In that case, your custom setup files are downloaded and run in the Azure-SSIS node (a VM) when you start the runtime.
In this section we will prepare custom setup files so that you can run SSIS packages with SSIS PowerPack connectors inside in Azure-SSIS runtime.
Trial Users
Use the step below if you are a Trial User, when you did not purchase a license key.
Proceed with these steps:
-
Download SSIS PowerPack trial installer.
Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit_Trial.msi.
-
Create a text file and name it main.cmd (make it all lowercase, very important).
-
Copy and paste this script into it and save it:
set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
dir /s /b > "%DIR%\file_list.txt"
echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
::Install SSIS PowerPack
msiexec /i "SSISPowerPackSetup_64bit_Trial.msi" ADDLOCAL=ALL /q /L*V "%DIR%\powerpack_trial_install_log.txt"
echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt"
dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt"
echo DONE : %TIME% >> "%DIR%\steps_log.txt"
echo complete
This is the entry-point script that is executed when Azure-SSIS runtime is started.
-
At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit_Trial.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.
Paid Customers
Use the steps below if you are a Paid Customer, when you purchased a license.
Proceed with these steps:
-
Download SSIS PowerPack paid installer.
Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit.msi.
-
Have your SSIS PowerPack license key handy, we will need it in the below script.
-
Create a text file and name it main.cmd (make it all lowercase, very important).
- Copy and paste the below script into it.
- Paste your license key by replacing parameter's
--register
argument with your real license key.
-
Finally, save main.cmd:
set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
dir /s /b > "%DIR%\file_list.txt"
echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
::Install SSIS PowerPack
msiexec /i "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q /L*V "%DIR%\powerpack_install_log.txt"
echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
::Activate PowerPack license (Optional)
"C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --register "lgGAAO0-----REPLACE-WITH-YOUR-LICENSE-KEY-----czM=" --logfile "%DIR%\powerpack_register_log.txt"
::Show System Info
echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt"
"C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt"
echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt"
dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt"
dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt"
echo DONE : %TIME% >> "%DIR%\steps_log.txt"
echo complete
This is the entry-point script that is executed when Azure-SSIS runtime is started.
-
At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.
Upload custom setup files to Azure Blob Storage container
Within Azure Blob Storage container we will store custom setup files we prepared in the previous step so that Azure-SSIS can use them in custom setup process.
Just perform these very simple, but very important steps:
-
Create Azure Blob Storage container, if you haven't done it already
Make sure you create and use Azure Blob Storage container instead of Azure Data Lake Storage folder.
Azure Data Lake Storage won't allow creating an SAS URI for the container, which is a crucial step in the process.
-
Find Blob Containers node, right-click on it and hit Create Blob Container option:
-
Upload the two custom setup files — main.cmd & the MSI installer — into your Azure Blob Storage container's folder:
- It was easy, wasn't it? It's time we create an SAS URI in the next step.
Create SAS URI for Azure Blob Container
Once you have custom setup files prepared, it's time we generate an SAS URI.
This SAS URI will be used by a new Azure-SSIS runtime to install SSIS PowerPack inside the runtime's node, a VM.
Let's proceed together by performing the steps below:
- Install and launch Azure Storage Explorer.
-
Right-click on the Storage Accounts node and then hit Connect to Azure storage... menu item:
-
Proceed by right-clicking on that container node and select Get Shared Access Signature... option.
-
Next, set the Expiry time field to a date far in the future.
If you restart Azure-SSIS runtime and your SAS URI is expired by that time, it will not start.
-
Select Read, Create, Write, and List permissions:
We also recommend to add Delete permission too to support future functionality.
-
Copy SAS URL to the clipboard and save it for the next step:
You can also generate and copy SAS URL from within Azure Portal itself:
Create Azure-SSIS integration runtime
Once you have the SAS URL we obtained in the previous step, we are ready to move on to create an Azure-SSIS runtime in Azure Data Factory:
-
Firstly, perform the steps described in Create an Azure-SSIS integration runtime article in Azure Data Factory reference.
-
In Advanced settings page section, configure Custom setup container SAS URI you obtained in the previous step:
-
And you are done! That was quick! You can see your Azure-SSIS runtime up and running:
The custom setup script is executed only once — at the time an Azure-SSIS runtime is started.
It is also executed if you stop and start Azure-SSIS runtime again.
Deploy SSIS package in Visual Studio
We are ready to deploy the SSIS package to Azure-SSIS runtime. Once you do that, proceed to the next step for the grand finale!
Execute SSIS package in SQL Server Management Studio (SSMS)
After all hard work, we are ready to execute SSIS package in SQL Server Management Studio (SSMS):
- Connect to the SQL Server which is linked to your Azure-SSIS runtime and contains SSISDB database.
-
Navigate to Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and hit Execute...:
-
To view the status of the past execution, navigate to
Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and select Reports » Standard Reports » All Executions menu item:
Scenarios
Moving SSIS PowerPack license to another Azure-SSIS runtime
If you are a Paid Customer, there will be a time when you no longer use Azure-SSIS runtime or you need to use your license on a different ADF instance.
To transfer a license from one Azure-SSIS runtime to another, perform these steps:
-
Copy & paste this script into main.cmd we used in the previous step:
set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
dir /s /b > "%DIR%\file_list.txt"
echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
::Install SSIS PowerPack
msiexec /i "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q /L*V "%DIR%\powerpack_install_log.txt"
echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
::De-Activate same license
"C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --unregister --logfile "%DIR%\powerpack_un_register_log.txt"
::Show System Info
echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt"
"C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt"
echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt"
dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt"
dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt"
echo DONE : %TIME% >> "%DIR%\steps_log.txt"
echo complete
- Start Azure-SSIS runtime.
This will unregister your license on the original Azure-SSIS runtime.
- Stop Azure-SSIS runtime to deallocate resources in Azure.
- Now you are free to activate it on another Azure-SSIS runtime.
Advanced topics
Actions supported by Zendesk Connector
Zendesk Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
Get a list of all tickets in your account [
Read more...]
Parameter |
Description |
Sort By |
Sort By field
Option |
Value |
id |
id |
assignee |
assignee |
assignee.name |
assignee.name |
created_at |
created_at |
group |
group |
locale |
locale |
requester |
requester |
requester.name |
requester.name |
status |
status |
subject |
subject |
updated_at |
updated_at |
|
Sort Order |
Sort order
Option |
Value |
desc |
desc |
asc |
asc |
|
Extra Columns to Include |
Option |
Value |
Default |
|
comment_count |
comment_count |
|
External ID for Ticket |
|
Records Per Page (Max 100) |
|
Read Tickets (Incremental) changed after a specified date
Get a list of tickets changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [
Read more...]
Parameter |
Description |
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) |
Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option |
Value |
now |
now |
now-5h |
now-5h |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Exclude Deleted |
Whether or not you'd like to exclude deleted tickets from the response
Option |
Value |
true |
true |
false |
false |
|
Page Size (Default 1000) |
Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
|
Read Users (Incremental) changed after a specified date
Get a list of users changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [
Read more...]
Parameter |
Description |
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) |
Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option |
Value |
now |
now |
now-5h |
now-5h |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Exclude Deleted |
Whether or not you'd like to exclude deleted tickets from the response
Option |
Value |
true |
true |
false |
false |
|
Page Size (Default 1000) |
Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
|
Read Organizations (Incremental) changed after a specified date
Get a list of organizations changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [
Read more...]
Parameter |
Description |
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) |
Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option |
Value |
now |
now |
now-5h |
now-5h |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Exclude Deleted |
Whether or not you'd like to exclude deleted tickets from the response
Option |
Value |
true |
true |
false |
false |
|
Page Size (Default 1000) |
Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
|
Read Ticket Events (Incremental) changed after a specified date
Returns a list of ticket events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [
Read more...]
Parameter |
Description |
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) |
Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option |
Value |
now |
now |
now-5h |
now-5h |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Read Ticket Metric Events (Incremental) changed after a specified date
Get a list of Ticket Metric Events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [
Read more...]
Parameter |
Description |
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) |
Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option |
Value |
now |
now |
now-5h |
now-5h |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Exclude Deleted |
Whether or not you'd like to exclude deleted tickets from the response
Option |
Value |
true |
true |
false |
false |
|
Page Size (Default 1000) |
Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
|
Get a list of all tickets in your account [
Read more...]
Parameter |
Description |
Ticket ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Get a list of users in your account for specific id(s) [
Read more...]
Parameter |
Description |
User ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Read Organization(s) by ID
Get a list of organizations in your account for specific id(s) [
Read more...]
Parameter |
Description |
Organization ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Read Tickets for Organization
Get all tickets for specified organization_id [
Read more...]
Parameter |
Description |
Organization ID |
|
Records Per Page (Max 100) |
|
Read Tickets for User (Requested)
Get all requested tickets for specified user_id [
Read more...]
Parameter |
Description |
User ID |
|
Records Per Page (Max 100) |
|
Read Tickets for User (CCed)
Get all CCed tickets for specified user_id [
Read more...]
Parameter |
Description |
User ID |
|
Records Per Page (Max 100) |
|
Read Tickets for User (Assigned)
Get all assigned tickets for specified user_id [
Read more...]
Parameter |
Description |
User ID |
|
Records Per Page (Max 100) |
|
Returns an approximate count of tickets in the account. If the count exceeds 100,000, it is updated every 24 hours. The count[refreshed_at] property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, count[refreshed_at] may occasionally be null. This indicates that the count is being updated in the background, and count[value] is limited to 100,000 until the update is complete. [
Read more...]
Read Tickets Count (for Organization)
Returns an approximate count of tickets for specified organization_id. If the count exceeds 100,000, it is updated every 24 hours. The count[refreshed_at] property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, count[refreshed_at] may occasionally be null. This indicates that the count is being updated in the background, and count[value] is limited to 100,000 until the update is complete. [
Read more...]
Parameter |
Description |
Organization ID |
|
Returns a list of tickets with their metrics. [
Read more...]
Parameter |
Description |
Records Per Page (Max 100) |
|
Returns a list of all system and custom ticket fields in your account. For accounts without access to multiple ticket forms, positions can be changed using the Update Ticket Field endpoint or the Ticket Forms page in Zendesk Support (Admin > Manage > Ticket Forms). The Ticket Forms page shows the fields for the account. The order of the fields is used in the different products to show the field values in the tickets. [
Read more...]
Returns a list of all ticket forms for your account if accessed as an admin or agent. End users only see ticket forms that have end_user_visible set to true. [
Read more...]
Returns comments for specified ticket ID. [
Read more...]
Parameter |
Description |
Ticket ID |
|
Sort Order |
Sort order
Option |
Value |
desc |
desc |
asc |
asc |
|
Include inline images |
Default is false. When true, inline images are also listed as attachments in the response
Option |
Value |
false |
false |
true |
true |
|
Returns attachments for the specified Ticket ID. [
Read more...]
Parameter |
Description |
Ticket ID |
|
Sort Order |
Sort order
Option |
Value |
desc |
desc |
asc |
asc |
|
Include inline images |
Default is false. When true, inline images are also listed as attachments in the response
Option |
Value |
false |
false |
true |
true |
|
Read Ticket ActivityStream
Lists ticket activities in the last 30 days affecting the agent making the request. The Ticket Activities API returns ticket activities by other people affecting the agent making the API request. Ticket activities include assigning a ticket to the agent, increasing the priority of a ticket assigned to the agent, or adding a comment to a ticket assigned to the agent. A possible use case for the API is building a personalized notification service for agents. [
Read more...]
Parameter |
Description |
Since (ISO e.g. 2013-04-03T16:02:46Z) |
return the activities since a specific date. The since parameter takes a UTC time in the ISO 8601 format. Example: '2013-04-03T16:02:46Z'.
|
Read Ticket ActivityStream Details
Lists ticket activity details. [
Read more...]
Parameter |
Description |
activity_id |
|
Search Records - WITH Sorting and Extra Columns (Max 1000 rows)
Search for ticket, user, organization, or group for specified search criteria. Returns max 1000 records based on search criteria (i.e. query) you specify [
Read more...]
Parameter |
Description |
Search Criteria |
The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226
Option |
Value |
Example: Search by Ticket ID |
112233 |
Example: Search by Ticket Status |
status
|
Example: Search by Some Text |
SomeText |
Example: Search By Status |
SomeText |
Example: Search by Type and Status |
type:ticket status:open |
Example: Search by Type and Name |
type:user "Jane Doe" |
Example: Search by Type and CreationDate |
type:organization created< 2015-05-01 |
Example: Search organizations updated after some date |
type:organization updated > 2015-05-01 |
Example: Search users updated after some date |
type:user updated > 2015-05-01 |
Example: Search By Type and Tag |
type:ticket tags:red tags:blue |
|
Sort By |
Option |
Value |
updated_at |
updated_at |
created_at |
created_at |
priority |
priority |
status |
status |
ticket_type |
ticket_type |
|
Sort Order |
Option |
Value |
desc |
desc |
asc |
asc |
|
Extra Columns to Include |
You can list email CCs by side-loading users.
Option |
Value |
Default |
|
users |
users |
|
Search Records - NO Sorting (Allows more than 1000 rows)
Search for ticket, user, organization, or group for specified search criteria. Sorting not allowed but you can get more than 1000 records unlike other endpoint for search which supports max 1000 rows but allows sorting if needed. [
Read more...]
Parameter |
Description |
FilterType |
Option |
Value |
ticket |
ticket |
organization |
organization |
user |
user |
group |
group |
|
Search Criteria |
The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226
Option |
Value |
Example: Search by Ticket ID |
112233 |
Example: Search by Ticket Status |
status
|
Example: Search by Some Text |
SomeText |
Example: Search By Status |
SomeText |
Example: Search by Type and Status |
type:ticket status:open |
Example: Search by Type and Name |
type:user "Jane Doe" |
Example: Search by Type and CreationDate |
type:organization created< 2015-05-01 |
Example: Search organizations updated after some date |
type:organization updated > 2015-05-01 |
Example: Search users updated after some date |
type:user updated > 2015-05-01 |
Example: Search By Type and Tag |
type:ticket tags:red tags:blue |
|
Returns a list of custom Organization Fields in your account. Fields are returned in the order that you specify in your Organization Fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each Organization Field to the values returned under the organization_fields attribute on the Organization resource. [
Read more...]
Lists the 500 most popular tags in the last 60 days, in decreasing popularity. You must enable the tagging of users and organizations in Zendesk Support for the API calls to work. Select Manage > Settings > Customers, and enable the option. [
Read more...]
Returns a list of custom User Fields in your account. Fields are returned in the order that you specify in your User Fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the user_fields attribute on the User resource. [
Read more...]
Parameter |
Description |
Filter |
Option |
Value |
all fields |
$.user_fields[*] |
date fields |
$.user_fields[?(@type=='date')] |
|
Get information for current profile based on credentials you have used. [
Read more...]
Get information about user sessions. [
Read more...]
Parameter |
Description |
user_id |
|
Returns a list of requests. [
Read more...]
Parameter |
Description |
Sort By |
Sort By field
Option |
Value |
updated_at |
updated_at |
created_at |
created_at |
|
Sort Order |
Sort order
Option |
Value |
desc |
desc |
asc |
asc |
|
Status |
Sort order
Option |
Value |
new |
new |
open |
open |
pending |
pending |
solved |
solved |
closed |
closed |
|
Returns a requests using search criteria. [
Read more...]
Parameter |
Description |
Sort By |
Sort By field
Option |
Value |
updated_at |
updated_at |
created_at |
created_at |
|
Sort Order |
Sort order
Option |
Value |
desc |
desc |
asc |
asc |
|
Search Criteria |
The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226
Option |
Value |
Example: Search by Ticket ID |
112233 |
Example: Search by Ticket Status |
status
|
Example: Search by Some Text |
SomeText |
Example: Search By Status |
SomeText |
Example: Search by Type and Status |
type:ticket status:open |
Example: Search by Type and Name |
type:user "Jane Doe" |
Example: Search by Type and CreationDate |
type:organization created< 2015-05-01 |
Example: Search organizations updated after some date |
type:organization updated > 2015-05-01 |
Example: Search users updated after some date |
type:user updated > 2015-05-01 |
Example: Search By Type and Tag |
type:ticket tags:red tags:blue |
|
Status |
Sort order
Option |
Value |
new |
new |
open |
open |
pending |
pending |
solved |
solved |
closed |
closed |
|
organization_id |
|
cc_id |
|
Read attachment information [
Read more...]
Parameter |
Description |
Attachment ID |
|
Delete attachment [
Read more...]
Parameter |
Description |
Attachment ID |
|
Upload Attachment (Single file)
Upload files to Zendesk which can be used as attachment later. [
Read more...]
Parameter |
Description |
File Name |
File name for display purpose
|
File Path (Local) |
|
Token for exising Upload Session |
Blank if creating a new upload
|
Delete upload session and all its attachments. [
Read more...]
Parameter |
Description |
Token for exising upload |
|
Creates one ticket at a time and wait until its created. Use BULK Table instead of this one to create multiple tickets. [
Read more...]
Create tickets in bulk (job is queued) and wait until done. This is faster than one request at a time [
Read more...]
Delete multiple tickets in a single request. This is faster than row by row operation. [
Read more...]
Parameter |
Description |
Ticket ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Update tickets in bulk (job is queued) and wait until done. This is faster than one request at a time [
Read more...]
Update single ticket. Use bulk operation if you pfrefer to update multiple tickets. If you like to set additional_tags or remove_tags then use BULK Table (Tickets) [
Read more...]
Parameter |
Description |
Ticket ID to Update |
|
Delete ticket by id. [
Read more...]
Parameter |
Description |
Ticket ID for Delete |
|
Get a list of all users in your account [
Read more...]
Parameter |
Description |
Role |
Option |
Value |
agent |
agent |
admin |
admin |
end-user |
end-user |
|
permission_set |
|
External ID for Ticket |
|
Records Per Page (Max 100) |
|
Get a list of all organizations in your account [
Read more...]
Parameter |
Description |
Records Per Page (Max 100) |
|
Upsert Users (Bulk) - Create or Update
Delete a user by its id [
Read more...]
Parameter |
Description |
User ID for Delete |
|
Upsert User - Create or Update
Delete an organization by its id [
Read more...]
Parameter |
Description |
Organization ID for Delete |
|
Upsert Organization - Create or Update
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
Body |
Request Body content goes here
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
Conclusion
In this article we discussed how to connect to Zendesk in Azure Data Factory (SSIS) and integrate data without any coding. Click here to Download Zendesk Connector for Azure Data Factory (SSIS) and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Zendesk Connector for Azure Data Factory (SSIS)
Documentation
More integrations
Other application integration scenarios for Zendesk
Other connectors for Azure Data Factory (SSIS)
Download Zendesk Connector for Azure Data Factory (SSIS)
Documentation
Common Searches:
How to connect Zendesk in Azure Data Factory (SSIS)?
How to get Zendesk data in Azure Data Factory (SSIS)?
How to read Zendesk data in Azure Data Factory (SSIS)?
How to load Zendesk data in Azure Data Factory (SSIS)?
How to import Zendesk data in Azure Data Factory (SSIS)?
How to pull Zendesk data in Azure Data Factory (SSIS)?
How to push data to Zendesk in Azure Data Factory (SSIS)?
How to write data to Zendesk in Azure Data Factory (SSIS)?
How to POST data to Zendesk in Azure Data Factory (SSIS)?
Call Zendesk API in Azure Data Factory (SSIS)
Consume Zendesk API in Azure Data Factory (SSIS)
Zendesk Azure Data Factory (SSIS) Automate
Zendesk Azure Data Factory (SSIS) Integration
Integration Zendesk in Azure Data Factory (SSIS)
Consume real-time Zendesk data in Azure Data Factory (SSIS)
Consume real-time Zendesk API data in Azure Data Factory (SSIS)
Zendesk ODBC Driver | ODBC Driver for Zendesk | ODBC Zendesk Driver | SSIS Zendesk Source | SSIS Zendesk Destination
Connect Zendesk in Azure Data Factory (SSIS)
Load Zendesk in Azure Data Factory (SSIS)
Load Zendesk data in Azure Data Factory (SSIS)
Read Zendesk data in Azure Data Factory (SSIS)
Zendesk API Call in Azure Data Factory (SSIS)