Zendesk Connectors

ZappySys connectors for Zendesk provide read / write capability inside your app (see list below), using these drag and drop , high performance connectors you can perform many Zendesk operations without any coding. You can use this connector to integrate Zendesk API data inside apps like SSIS, SQL Server or popular ETL Platforms / BI Tools/ Reporting Apps / Programming languages (i.e. Informatica, Power BI, SSRS, Excel, C#, JAVA, Python)

Documentation 

Video Tutorial - Zendesk Connectors - REST API Integration

Click on your App below to get started with Zendesk Integration

Choose your App / Scenario for which you like to integrate Zendesk

API Actions for Zendesk

Zendesk Connectors 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.
 Read Tickets (All)
Get a list of all tickets in your account
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
 Read Tickets (Incremental)
Get a list of tickets after specified date/time
Parameter Description
Start Time (i.e. yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss) Start DateTime for data fetch. Date format must be in ISO format yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss
 Read Ticket(s) by ID
Get a list of all tickets in your account
Parameter Description
Ticket ID(S) - Use Comma for multiple (e.g. 111,222)
 Read Tickets for Organization
Get all tickets for specified organization_id
Parameter Description
Organization ID
 Read Tickets for User (Requested)
Get all requested tickets for specified user_id
Parameter Description
User ID
 Read Tickets for User (CCed)
Get all CCed tickets for specified user_id
Parameter Description
User ID
 Read Tickets for User (Assigned)
Get all assigned tickets for specified user_id
Parameter Description
User ID
 Read Tickets (Recent)
Get all recent tickets
 Read Tickets Count (All)
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 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.
Parameter Description
Organization ID
 Read Ticket Metrics
Returns a list of tickets with their metrics..
 Read Ticket Fields
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 Ticket Forms
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 Ticket Comments
Returns comments for specified ticket ID.
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 Attachments
Returns attachments for the specified Ticket ID.
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.
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.
Parameter Description
activity_id
 Search Records
Returns max 1000 records based on search criteria (i.e. query) you specify
Parameter Description
query
Option Value
Example: Search by Ticket ID 112233
Example: Search by Ticket Status status<solved
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 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
 Read Organizations
Lists organizations.
 Read Organization Count
Get organizations count.
 Read Organization Fields
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 Tags
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 Groups
Get information about groups.
 Read Users
Get information about users.
 Read User Fields
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 Current User Info
Get information for current profile based on credentials you have used.
 Read Brands
Get information about brands.
 Read Views
Get information about views.
 Read Macros
Get information about macros.
 Read Sessions
Get information about Sessions.
 Read User Sessions
Get information about user sessions.
Parameter Description
user_id
 Read Requests
Returns a list of requests.
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
 Read Requests Search
Returns a requests using search criteria.
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
query
Option Value
Example: Search by Ticket ID 112233
Example: Search by Ticket Status status<solved
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 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
Read attachment information
Parameter Description
Attachment ID
 Delete Attachment
Delete attachment
Parameter Description
Attachment ID
 Upload Attachment (Single file)
Upload files to Zendesk which can be used as attachment later.
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
Delete upload session and all its attachments.
Parameter Description
Token for exising upload
 Create Ticket (Single)
Creates one ticket at a time and wait until its created.
 Create Tickets (Bulk)
Create tickets in bulk (job is queued) and wait until done. This is faster than one request at a time
 Delete Tickets (Bulk)
Delete multiple tickets in a single request. This is faster than row by row operation.
Parameter Description
Ticket ID(S) - Use Comma for multiple (e.g. 111,222)
 Update Tickets (Bulk)
Update tickets in bulk (job is queued) and wait until done. This is faster than one request at a time
 Delete Ticket
Delete ticket by id.
Parameter Description
Ticket ID for Delete
 Generic Request
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.
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 Check 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. 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