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. In this article you will learn how to quickly and efficiently integrate Zendesk data in Azure Data Factory (SSIS) without coding. We will use high-performance Zendesk Connector to easily connect to Zendesk and then access the data inside Azure Data Factory (SSIS). Let's follow the steps below to see how we can accomplish that! Zendesk Connector for Azure Data Factory (SSIS) is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
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 ~/Views/IntegrationHub/ContentBlocks/Links/SSIS-PowerPack/DownloadTrial.cshtmlSSIS 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.
Actions supported by Zendesk Connector
Zendesk Connector supports following actions for REST API integration:
Create Organization
Description
Create an organization.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Create Ticket (Single)
Description
Creates one ticket at a time and wait until its created. Use BULK Table instead of this one to create multiple tickets.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Create Tickets (Bulk)
Description
Create tickets in bulk (job is queued) and wait until done. This is faster than one request at a time.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
additional_tags
-
remove_tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
job_id
-
message
-
total
-
status
-
url
-
account_id
-
ticket_id
-
index
Visit documentation for more information.
Create User
Description
Create a user.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
email
-
alias
-
time_zone
-
phone
-
shared_phone_number
-
photo_id
-
locale_id
-
locale
-
organization_id
-
organization_name
-
role
-
verified
-
external_id
-
tags
-
signature
-
details
-
notes
-
remote_photo_url
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
photo
-
user_fields
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Delete Attachment
Description
Delete attachment.
Parameters
You can provide the following parameters to this action:
-
Attachment ID
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
attachment_id
Visit documentation for more information.
Delete Organization
Description
Delete an organization by its id.
Parameters
You can provide the following parameters to this action:
-
Organization ID for Delete
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Delete Ticket
Description
Delete ticket by id.
Parameters
You can provide the following parameters to this action:
-
Ticket ID for Delete
Input Fields
You can provide the following fields to this action:
-
id
Output Fields
The following fields are returned after calling this action:
-
Response
Visit documentation for more information.
Delete Tickets (Bulk)
Description
Delete multiple tickets in a single request. This is faster than row by row operation.
Parameters
You can provide the following parameters to this action:
-
Ticket ID(S) - Use Comma for multiple (e.g. 111,222)
Input Fields
You can provide the following fields to this action:
-
$$ticket_ids
Output Fields
The following fields are returned after calling this action:
-
job_id
-
message
-
total
-
job_status
-
url
-
title
-
errors
-
ticket_id
-
status
-
success
Visit documentation for more information.
Delete Upload Session
Description
Delete upload session and all its attachments.
Parameters
You can provide the following parameters to this action:
-
Token for exising upload
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Response
Visit documentation for more information.
Delete User
Description
Delete a user by its id.
Parameters
You can provide the following parameters to this action:
-
User ID for Delete
Input Fields
You can provide the following fields to this action:
-
external_id
-
default_group_id
-
email
-
alias
-
custom_role_id
-
details
-
id
-
photo_id
-
photo
-
name
-
suspended
-
restricted_agent
-
only_private_comments
-
ticket_restriction
-
moderator
-
time_zone
-
remote_photo_url
-
shared_phone_number
-
notes
-
signature
-
tags
-
user_fields
-
verified
-
role
-
organization_name
-
organization_id
-
locale
-
locale_id
-
phone
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Read Attachment
Description
Read attachment information.
Parameters
You can provide the following parameters to this action:
-
Attachment ID
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
attachment_id
-
attachment_file_name
-
attachment_content_url
-
attachment_url
-
attachment_content_type
-
attachment_size
-
attachment_height
-
attachment_width
-
attachment_deleted
-
attachment_inline
-
attachment_thumbnail_id
-
attachment_thumbnail_file_name
-
attachment_thumbnail_content_url
-
attachment_thumbnail_url
-
attachment_thumbnail_content_type
-
attachment_thumbnail_size
-
attachment_thumbnail_height
-
attachment_thumbnail_width
-
attachment_thumbnail_deleted
-
attachment_thumbnail_inline
Visit documentation for more information.
Read Brands
Description
Get information about brands.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Current User Info
Description
Get information for current profile based on credentials you have used.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Groups
Description
Get information about groups.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Macros
Description
Get information about macros.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Organization Count
Description
Get organizations count.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
value
-
refreshed_at
Visit documentation for more information.
Read Organization Fields
Description
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.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Organization(s) by ID
Description
Get a list of organizations in your account for specific id(s).
Parameters
You can provide the following parameters to this action:
-
Organization ID(S) - Use Comma for multiple (e.g. 111,222)
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
-
$$organization_ids
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Read Organizations (All)
Description
Get a list of all organizations in your account.
Parameters
You can provide the following parameters to this action:
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Read Organizations (Incremental) changed after a specified date
Description
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.
Parameters
You can provide the following parameters to this action:
-
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)
-
Exclude Deleted
-
Page Size (Default 1000)
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Read Requests
Description
Returns a list of requests.
Parameters
You can provide the following parameters to this action:
-
Sort By
-
Sort Order
-
Status
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Requests Search
Description
Returns a requests using search criteria.
Parameters
You can provide the following parameters to this action:
-
Search Criteria
-
Sort By
-
Sort Order
-
Status
-
organization_id
-
cc_id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Sessions
Description
Get information about Sessions.
Parameters
You can provide the following parameters to this action:
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Tags
Description
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.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket ActivityStream
Description
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.
Parameters
You can provide the following parameters to this action:
-
Since (ISO e.g. 2013-04-03T16:02:46Z)
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket ActivityStream Details
Description
Lists ticket activity details.
Parameters
You can provide the following parameters to this action:
-
activity_id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket Attachments
Description
Returns attachments for the specified Ticket ID.
Parameters
You can provide the following parameters to this action:
-
Ticket ID
-
Sort Order
-
Include inline images
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
id
-
file_name
-
content_url
-
mapped_content_url
-
content_type
-
size
-
width
-
height
-
inline
-
deleted
-
thumbnails
-
comment_id
Visit documentation for more information.
Read Ticket Comments
Description
Returns comments for specified ticket ID.
Parameters
You can provide the following parameters to this action:
-
Ticket ID
-
Sort Order
-
Include inline images
Input Fields
You can provide the following fields to this action:
-
author_id
-
body
Output Fields
The following fields are returned after calling this action:
-
id
-
author_id
-
body
-
plain_body
-
html_body
-
created_at
-
attachments
-
type
-
public
-
attachments_1_id
-
attachments_2_id
-
attachments_3_id
-
attachments_4_id
-
attachments_5_id
-
attachments_1_file_name
-
attachments_2_file_name
-
attachments_3_file_name
-
attachments_4_file_name
-
attachments_5_file_name
-
attachments_1_content_url
-
attachments_2_content_url
-
attachments_3_content_url
-
attachments_4_content_url
-
attachments_5_content_url
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_from_original_recipients
-
via_source_to_name
-
via_source_to_address
Visit documentation for more information.
Read Ticket Events (Incremental) changed after a specified date
Description
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.
Parameters
You can provide the following parameters to this action:
-
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket Fields
Description
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.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket Forms
Description
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.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket Metric Events (Incremental) changed after a specified date
Description
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.
Parameters
You can provide the following parameters to this action:
-
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)
-
Exclude Deleted
-
Page Size (Default 1000)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read Ticket Metrics
Description
Returns a list of tickets with their metrics.
Parameters
You can provide the following parameters to this action:
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
id
-
ticket_id
-
created_at
-
updated_at
-
group_stations
-
assignee_stations
-
reopens
-
replies
-
assignee_updated_at
-
requester_updated_at
-
status_updated_at
-
initially_assigned_at
-
assigned_at
-
solved_at
-
latest_comment_added_at
-
reply_time_in_minutes.calendar
-
reply_time_in_minutes.business
-
first_resolution_time_in_minutes.calendar
-
first_resolution_time_in_minutes.business
-
full_resolution_time_in_minutes.calendar
-
full_resolution_time_in_minutes.business
-
agent_wait_time_in_minutes.calendar
-
agent_wait_time_in_minutes.business
-
requester_wait_time_in_minutes.calendar
-
requester_wait_time_in_minutes.business
-
on_hold_time_in_minutes.calendar
-
on_hold_time_in_minutes.business
-
url
Visit documentation for more information.
Read Ticket(s) by ID
Description
Get a list of all tickets in your account.
Parameters
You can provide the following parameters to this action:
-
Ticket ID(S) - Use Comma for multiple (e.g. 111,222)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
$$ticket_ids
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets (All)
Description
Get a list of all tickets in your account.
Parameters
You can provide the following parameters to this action:
-
Sort By
-
Sort Order
-
Extra Columns to Include
-
External ID for Ticket
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets (Incremental) changed after a specified date
Description
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.
Parameters
You can provide the following parameters to this action:
-
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)
-
Exclude Deleted
-
Page Size (Default 1000)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets (Recent)
Description
Get all recent tickets.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets Count (All)
Description
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.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
value
-
refreshed_at
Visit documentation for more information.
Read Tickets Count (for Organization)
Description
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.
Parameters
You can provide the following parameters to this action:
-
Organization ID
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
value
-
refreshed_at
Visit documentation for more information.
Read Tickets for Organization
Description
Get all tickets for specified organization_id.
Parameters
You can provide the following parameters to this action:
-
Organization ID
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets for User (Assigned)
Description
Get all assigned tickets for specified user_id.
Parameters
You can provide the following parameters to this action:
-
User ID
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets for User (CCed)
Description
Get all CCed tickets for specified user_id.
Parameters
You can provide the following parameters to this action:
-
User ID
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read Tickets for User (Requested)
Description
Get all requested tickets for specified user_id.
Parameters
You can provide the following parameters to this action:
-
User ID
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
subject
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
comment_public
-
comment_author_id
-
tags
-
custom_fields
-
external_id
-
requester_name
-
requester_email
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
follower_ids
-
email_cc_ids
-
forum_topic_id
-
problem_id
-
is_public
-
due_at
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Read User Fields
Description
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.
Parameters
You can provide the following parameters to this action:
-
Filter
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read User Sessions
Description
Get information about user sessions.
Parameters
You can provide the following parameters to this action:
-
user_id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Read User(s) by ID
Description
Get a list of users in your account for specific id(s).
Parameters
You can provide the following parameters to this action:
-
User ID(S) - Use Comma for multiple (e.g. 111,222)
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
email
-
alias
-
time_zone
-
phone
-
shared_phone_number
-
photo_id
-
locale_id
-
locale
-
organization_id
-
organization_name
-
role
-
verified
-
external_id
-
tags
-
signature
-
details
-
notes
-
remote_photo_url
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
photo
-
user_fields
-
identities
-
$$user_ids
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Read Users (All)
Description
Get a list of all users in your account.
Parameters
You can provide the following parameters to this action:
-
Role
-
permission_set
-
External ID for Ticket
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
email
-
alias
-
time_zone
-
phone
-
shared_phone_number
-
photo_id
-
locale_id
-
locale
-
organization_id
-
organization_name
-
role
-
verified
-
external_id
-
tags
-
signature
-
details
-
notes
-
remote_photo_url
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
photo
-
user_fields
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Read Users (Incremental) changed after a specified date
Description
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.
Parameters
You can provide the following parameters to this action:
-
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)
-
Exclude Deleted
-
Page Size (Default 1000)
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
email
-
alias
-
time_zone
-
phone
-
shared_phone_number
-
photo_id
-
locale_id
-
locale
-
organization_id
-
organization_name
-
role
-
verified
-
external_id
-
tags
-
signature
-
details
-
notes
-
remote_photo_url
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
photo
-
user_fields
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Read Views
Description
Get information about views.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Search Records - NO Sorting (Allows more than 1000 rows)
Description
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.
Parameters
You can provide the following parameters to this action:
-
Search Criteria
-
FilterType
-
Records Per Page (Max 100)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Search Records - WITH Sorting and Extra Columns (Max 1000 rows)
Description
Search for ticket, user, organization, or group for specified search criteria. Returns max 1000 records based on search criteria (i.e. query) you specify.
Parameters
You can provide the following parameters to this action:
-
Search Criteria
-
Sort By
-
Sort Order
-
Extra Columns to Include
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Update Organization
Description
Update an organization by its id.
Parameters
You can provide the following parameters to this action:
-
id
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Update Ticket (Single)
Description
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).
Parameters
You can provide the following parameters to this action:
-
Ticket ID to Update
Input Fields
You can provide the following fields to this action:
-
id
-
allow_channelback
-
brand_id
-
followup_ids
-
fields
-
sharing_agreement_ids
-
due_at
-
is_public
-
problem_id
-
forum_topic_id
-
email_cc_ids
-
follower_ids
-
collaborator_ids
-
group_id
-
organization_id
-
allow_attachments
-
assignee_id
-
requester_id
-
requester_email
-
requester_name
-
external_id
-
custom_fields
-
tags
-
comment_author_id
-
comment_public
-
comment_body_html
-
comment_body
-
priority
-
type
-
status
-
recipient
-
submitter_id
-
subject
Output Fields
The following fields are returned after calling this action:
-
id
-
recipient
-
subject
-
status
-
type
-
priority
-
description
-
external_id
-
created_at
-
updated_at
-
raw_subject
-
url
-
comment_count
-
requester_id
-
submitter_id
-
assignee_id
-
organization_id
-
group_id
-
collaborator_ids
-
collaborator_ids_1
-
collaborator_ids_2
-
collaborator_ids_3
-
follower_ids
-
follower_ids_1
-
follower_ids_2
-
follower_ids_3
-
email_cc_ids
-
email_cc_ids_1
-
email_cc_ids_2
-
email_cc_ids_3
-
forum_topic_id
-
problem_id
-
has_incidents
-
is_public
-
due_at
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
custom_fields
-
custom_fields_1_id
-
custom_fields_1_value
-
custom_fields_2_id
-
custom_fields_2_value
-
custom_fields_3_id
-
custom_fields_3_value
-
custom_fields_4_id
-
custom_fields_4_value
-
custom_fields_5_id
-
custom_fields_5_value
-
via_followup_source_id
-
satisfaction_rating_id
-
satisfaction_rating_score
-
satisfaction_rating_comment
-
sharing_agreement_ids
-
fields
-
followup_ids
-
brand_id
-
allow_channelback
-
allow_attachments
-
via_channel
-
via_source_rel
-
via_source_from_address
-
via_source_from_name
-
via_source_to_name
-
via_source_to_address
-
via_source_from_ticket_id
-
via_source_from_subject
-
via_source_from_channel
-
custom_field_[Dynamic Column]
Visit documentation for more information.
Update Tickets (Bulk)
Description
Update tickets in bulk (job is queued) and wait until done. This is faster than one request at a time.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
allow_attachments
-
allow_channelback
-
brand_id
-
followup_ids
-
fields
-
group_id
-
due_at
-
collaborator_ids
-
assignee_id
-
forum_topic_id
-
email_cc_ids
-
follower_ids
-
id
-
sharing_agreement_ids
-
organization_id
-
is_public
-
problem_id
-
submitter_id
-
requester_email
-
recipient
-
status
-
type
-
priority
-
comment_body
-
comment_body_html
-
requester_id
-
comment_public
-
tags
-
additional_tags
-
remove_tags
-
custom_fields
-
external_id
-
requester_name
-
comment_author_id
-
subject
Output Fields
The following fields are returned after calling this action:
-
job_id
-
message
-
total
-
job_status
-
url
-
index
-
error
-
details
-
ticket_id
-
status
-
success
Visit documentation for more information.
Update User
Description
Update a user by its id.
Parameters
You can provide the following parameters to this action:
-
id
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
email
-
alias
-
time_zone
-
phone
-
shared_phone_number
-
photo_id
-
locale_id
-
locale
-
organization_id
-
organization_name
-
role
-
verified
-
external_id
-
tags
-
signature
-
details
-
notes
-
remote_photo_url
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
photo
-
user_fields
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Upload Attachment (Single file)
Description
Upload files to Zendesk which can be used as attachment later.
Parameters
You can provide the following parameters to this action:
-
File Name
-
File Path (Local)
-
Token for exising Upload Session
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
token
-
expires_at
-
attachment_id
-
attachment_file_name
-
attachment_content_url
-
attachment_url
-
attachment_content_type
-
attachment_size
-
attachment_height
-
attachment_width
-
attachment_deleted
-
attachment_inline
-
attachment_thumbnail_id
-
attachment_thumbnail_file_name
-
attachment_thumbnail_content_url
-
attachment_thumbnail_url
-
attachment_thumbnail_content_type
-
attachment_thumbnail_size
-
attachment_thumbnail_height
-
attachment_thumbnail_width
-
attachment_thumbnail_deleted
-
attachment_thumbnail_inline
Visit documentation for more information.
Upsert Organization - Create or Update
Description
Create or Update an organization in (Upsert).
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
notes
-
external_id
-
group_id
-
details
-
tags
-
organization_fields
-
domain_names
-
shared_comments
-
shared_tickets
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
notes
-
created_at
-
details
-
domain_names
-
domain_names_1
-
domain_names_2
-
domain_names_3
-
external_id
-
group_id
-
shared_comments
-
shared_tickets
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
updated_at
-
url
-
organization_field_dt_[Dynamic Column]
-
organization_field_[Dynamic Column]
Visit documentation for more information.
Upsert User - Create or Update
Description
Create or Update a user in (Upsert).
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
id
-
name
-
email
-
alias
-
time_zone
-
phone
-
shared_phone_number
-
photo_id
-
locale_id
-
locale
-
organization_id
-
organization_name
-
role
-
verified
-
external_id
-
tags
-
signature
-
details
-
notes
-
remote_photo_url
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
photo
-
user_fields
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
name
-
email
-
active
-
role
-
created_at
-
updated_at
-
time_zone
-
iana_time_zone
-
phone
-
url
-
shared_phone_number
-
locale_id
-
locale
-
organization_id
-
role_type
-
verified
-
external_id
-
tags
-
tags_1
-
tags_2
-
tags_3
-
tags_4
-
tags_5
-
alias
-
shared
-
shared_agent
-
last_login_at
-
two_factor_auth_enabled
-
signature
-
details
-
notes
-
custom_role_id
-
moderator
-
ticket_restriction
-
only_private_comments
-
restricted_agent
-
suspended
-
default_group_id
-
report_csv
-
photo_url
-
photo_id
-
photo_file_name
-
photo_content_url
-
photo_mapped_content_url
-
photo_content_type
-
photo_size
-
photo_width
-
photo_height
-
photo_inline
-
photo_deleted
-
photo_thumbnails
-
user_field_dt_[Dynamic Column]
-
user_field_[Dynamic Column]
Visit documentation for more information.
Upsert Users (Bulk) - Create or Update
Description
Create or Update users in bulk (Upsert).
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
external_id
-
default_group_id
-
email
-
alias
-
custom_role_id
-
details
-
id
-
photo_id
-
photo
-
name
-
suspended
-
restricted_agent
-
only_private_comments
-
ticket_restriction
-
moderator
-
time_zone
-
remote_photo_url
-
shared_phone_number
-
notes
-
signature
-
tags
-
user_fields
-
verified
-
role
-
organization_name
-
organization_id
-
locale
-
locale_id
-
phone
-
identities
Output Fields
The following fields are returned after calling this action:
-
id
-
email
-
status
-
success
-
job_id
-
message
-
total
-
job_status
-
job_url
-
index
-
error
-
details
Visit documentation for more information.
Make Generic API Request
Description
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.
Parameters
You can provide the following parameters to this action:
-
Url
-
Body
-
IsMultiPart
-
Filter
-
Headers
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Make Generic API Request (Bulk Write)
Description
This is a generic endpoint for bulk write purpose. 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.
Parameters
You can provide the following parameters to this action:
-
Url
-
IsMultiPart
-
Filter
-
Headers
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Conclusion
In this article we showed you how to connect to Zendesk in Azure Data Factory (SSIS) and integrate data without any coding, saving you time and effort.
We encourage you to download Zendesk Connector for Azure Data Factory (SSIS) 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 (SSIS) Documentation