JAVA Zendesk Connector

In this article you will learn how to integrate Zendesk data to JAVA (live / bi-directional connection to Zendesk). Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more..

Using Zendesk Connector you will be able to connect, read, and write data from within JAVA. Follow the steps below to see how we would accomplish that.

Download  Help File  Buy 

Create Data Source in ZappySys Data Gateway based on ZappySys API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    ZendeskDSN

    ZappySys Data Gateway - Add Data Source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "Zendesk" from the list of Popular Connectors. If "Zendesk" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    ZendeskDSN
    Zendesk
    ODBC DSN Template Selection

  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

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

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

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

    Fill in all required parameters and set optional parameters if needed:

    ZendeskDSN
    Zendesk
    Token Authentication [Http]
    https://[$Domain$].zendesk.com/api/v2
    Required Parameters
    Sub Domain (e.g. mycompany) Fill in the parameter...
    UserId Fill in the parameter...
    Token Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

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

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

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

    Fill in all required parameters and set optional parameters if needed:

    ZendeskDSN
    Zendesk
    OAuth Authentication [OAuth]
    https://[$Domain$].zendesk.com/api/v2
    Required Parameters
    Sub Domain (e.g. mycompany) Fill in the parameter...
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    Permissions Fill in the parameter...
    RedirectUrl Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

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

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

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

    Fill in all required parameters and set optional parameters if needed:

    ZendeskDSN
    Zendesk
    UserID/Password Authentication (2FA must be OFF) [Http]
    https://[$Domain$].zendesk.com/api/v2
    Required Parameters
    Sub Domain (e.g. mycompany) Fill in the parameter...
    UserName (2FA Must be OFF) Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

  7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Read data in Java from the DSN

  1. Java code to get the data:

    "jdbc:sqlserver://localhost:5000;databasename=ZendeskDSN;user=tdsuser;password=test"
    Java code to Make ZappySys Driver Data Source Call

  2. When you run the code it will make the API call and read the data:
    Java code ZappySys Driver Data Source Results

  3. Here is Java program's code in text format:

    
    //Step-1: Install ZappySys ODBC PowerPack and Configure Data Gateway
    
    //Step-2:Assuming the Microsoft SQL Server JDBC Driver is in below folder
    //C:\Program Files\Microsoft Jdbc Driver 6.0 for SQL Server\sqljdbc_6.0\enu\auth\x64
    package padaone;
    
    import java.sql.*;
    
    public class zappy {
    
        public static void main(String[] args) {
    
            // Create a variable for the connection string.
            String connectionUrl = "jdbc:sqlserver://localhost:5000;databasename=ZendeskDSN;user=test;password=test";
    
            // Declare the JDBC objects.
            Connection con = null;
            Statement stmt = null;
            ResultSet rs = null;
    
                try {
                    // Establish the connection.
                    Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
                    con = DriverManager.getConnection(connectionUrl);
    
                    // Create and execute an SQL statement that returns some data.
                    String SQL = "SELECT Country , SUM(UnitPrice * Quantity) Total " 
                               + "FROM value " 
                               + "GROUP BY Country "
                               + "WITH (SRC='https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json')";
                    stmt = con.createStatement();
                    rs = stmt.executeQuery(SQL);
    
                    // Iterate through the data in the result set and display it.
                    while (rs.next()) {
                        System.out.println(rs.getString(1) + " " + rs.getString(2));
                    }
                }
    
            // Handle any errors that may have occurred.
            catch (Exception e) {
                e.printStackTrace();
            } 
            
            finally {
                if (rs != null) try { rs.close(); } catch (Exception e) {}
                if (stmt != null) try { stmt.close(); } catch (Exception e) {}
                if (con != null) try { con.close(); } catch (Exception e) {}
            }
        }
    }

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Store Procedure

  5. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

In this article we discussed how to connect to Zendesk in JAVA and integrate data without any coding. Click here to Download Zendesk Connector for JAVA 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 JAVA Documentation 

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.
 Read Tickets (All)
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
 Read Tickets changed after date (Incremental)
Get a list of tickets changed after specified date/time    [Read more...]
Parameter Description
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) Start DateTime for data fetch. Tickets 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)
Option Value
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(s) by ID
Get a list of all tickets in your account    [Read more...]
Parameter Description
Ticket ID(S) - Use Comma for multiple (e.g. 111,222)
 Read User(s) by ID
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
 Read Tickets for User (Requested)
Get all requested tickets for specified user_id    [Read more...]
Parameter Description
User ID
 Read Tickets for User (CCed)
Get all CCed tickets for specified user_id    [Read more...]
Parameter Description
User ID
 Read Tickets for User (Assigned)
Get all assigned tickets for specified user_id    [Read more...]
Parameter Description
User ID
 Read Tickets (Recent)
Get all recent tickets    [Read more...]
 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 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
 Read Ticket Metrics
Returns a list of tickets with their metrics..    [Read more...]
 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 more...]
Parameter Description
 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 more...]
 Read Ticket Comments
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
 Read Ticket Attachments
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: &#39;2013-04-03T16:02:46Z&#39;.
 Read Ticket ActivityStream Details
Lists ticket activity details.    [Read more...]
Parameter Description
activity_id
 Search Records
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&lt;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 &quot;Jane Doe&quot;
Example: Search by Type and CreationDate type:organization created&lt; 2015-05-01
Example: Search organizations updated after some date type:organization updated &gt; 2015-05-01
Example: Search users updated after some date type:user updated &gt; 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 Organization Count
Get organizations count.    [Read more...]
 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 more...]
 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 more...]
 Read Groups
Get information about groups.    [Read more...]
 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 more...]
Parameter Description
Filter
Option Value
all fields $.user_fields[*]
date fields $.user_fields[?(@type==&#39;date&#39;)]
 Read Current User Info
Get information for current profile based on credentials you have used.    [Read more...]
 Read Brands
Get information about brands.    [Read more...]
 Read Views
Get information about views.    [Read more...]
 Read Macros
Get information about macros.    [Read more...]
 Read Sessions
Get information about Sessions.    [Read more...]
 Read User Sessions
Get information about user sessions.    [Read more...]
Parameter Description
user_id
 Read Requests
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
 Read Requests Search
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&lt;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 &quot;Jane Doe&quot;
Example: Search by Type and CreationDate type:organization created&lt; 2015-05-01
Example: Search organizations updated after some date type:organization updated &gt; 2015-05-01
Example: Search users updated after some date type:user updated &gt; 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    [Read more...]
Parameter Description
Attachment ID
 Delete Attachment
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
Delete upload session and all its attachments.    [Read more...]
Parameter Description
Token for exising upload
 Create Ticket (Single)
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 (Bulk)
Create tickets in bulk (job is queued) and wait until done. This is faster than one request at a time    [Read more...]
 Delete Tickets (Bulk)
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 (Bulk)
Update tickets in bulk (job is queued) and wait until done. This is faster than one request at a time    [Read more...]
 Update Ticket (Single)
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
Delete ticket by id.    [Read more...]
Parameter Description
Ticket ID for Delete
 Read Users (All)
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
 Read Organizations (All)
Get a list of all organizations in your account    [Read more...]
 Upsert Users (Bulk) - Create or Update
Create or Update users in bulk (Upsert)    [Read more...]
 Delete User
Delete a user by its id    [Read more...]
Parameter Description
User ID for Delete
 Update User
Update a user by its id    [Read more...]
Parameter Description
id
 Create User
Create a user    [Read more...]
 Upsert User - Create or Update
Create or Update a user in (Upsert)    [Read more...]
 Delete Organization
Delete an organization by its id    [Read more...]
Parameter Description
Organization ID for Delete
 Update Organization
Update an organization by its id    [Read more...]
Parameter Description
id
 Create Organization
Create an organization    [Read more...]
 Upsert Organization - Create or Update
Create or Update an organization in (Upsert)    [Read more...]
 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.    [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 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. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header =&gt; 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

Zendesk Connector Examples for JAVA Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Get all Tickets    [Read more...]

Read all tickets from Zendesk

SELECT * FROM Tickets

Get Ticket information by ID(s)    [Read more...]

Read multiple ticket information from Zendesk by ID(s)

SELECT * from get_tickets_by_ids
WITH(ticket_ids='104861,104860')

Get Single Ticket information by ID    [Read more...]

SELECT * from Tickets
WHERE ID=104861

Get all tickets modified after ceratin date/time    [Read more...]

Read tickets modified after ceratin date/time. This is incremental data fetch.

SELECT * FROM get_tickets_incr
WITH(
	  start_time='2012-01-31T00:00:00'
)

Get all tickets for specific organization    [Read more...]

Read tickets for a specified organization_id (company).

SELECT * FROM get_tickets_by_org
WITH(
	  organization_id='12'
)

Get all tickets for a specific user who requested ticket(s)    [Read more...]

Read tickets for a specified user_id who is listed as requested by.

SELECT * FROM get_tickets_for_user_requested
WITH(
	  user_id='123'
)

Get all tickets for a specific user who is CCed on ticket(s)    [Read more...]

Read tickets for a specified user_id who is listed as CC.

SELECT * FROM get_tickets_for_user_cced
WITH(
	  user_id='123'
)

Get all tickets for a specific user who is assigned to ticket(s)    [Read more...]

Read tickets for a specified user_id who is assigned to ticket(s).

SELECT * FROM get_tickets_for_user_assigned
WITH(
	  user_id='123'
)

Get total tickets count    [Read more...]

SELECT * FROM get_tickets_count

Get total tickets count for a specific organization    [Read more...]

SELECT * FROM get_tickets_count_org
WITH(
	  organization_id='123'
)

Get all attachment urls for a specific ticket    [Read more...]

SELECT * FROM get_ticket_attachments
WITH(
	  ticket_id='104351'
)

Get User(s)    [Read more...]

SELECT * FROM Users --Where Id=1234

Get multiple users by ID(s)    [Read more...]

Read multiple user information from Zendesk by ID(s)

SELECT * from get_users_by_ids
WITH(user_ids='1111,2222,3333')

Get Organization(s)    [Read more...]

SELECT * FROM Organizations --Where Id=1234

Get multiple organizations by ID(s)    [Read more...]

Read multiple organization information from Zendesk by ID(s)

SELECT * from get_organizations_by_ids
WITH(organization_ids='1111,2222,3333')

Create a new ticket    [Read more...]

Use Tickets_Bulk instead of Tickets table if you like to multiple tickets at once. Tickets_Bulk table supports BULK operation (using SOURCE clause).

INSERT INTO Tickets(
	subject
	,status
	,assignee_id
	,comment_body_html --(for html body)
	--,comment_body (for plain text)
	,comment_public
	,tags
	,custom_fields)
VALUES(
  'Test Ticket Subject - From email'
, 'new' --new, solved, closed
, 18590685428 --assign to agent id
, 'This is <b>html body</b>' --markup also supported
, 1 --1=public, 0=private 
, '["tag1","tag2"]' 
  --below json can be obtained using select custom_fields from tickets where id=1234
, '[
  {
    "id": 56608448,
    "value": "1122"
  },
  {
    "id": 57385967,
    "value": "ORD-12345"
  }
]'
)

Create a new ticket (behalf of user)    [Read more...]

This example creates ticket behalf of user (i.e. requester_email and requester_name) and if user is missing then creates a new user for supplied username and email. Use Tickets_Bulk instead of Tickets table if you like to multiple tickets at once. Tickets_Bulk table supports BULK operation (using SOURCE clause).

INSERT INTO Tickets(
	subject
	,status
	,requester_email
	,requester_name
	,assignee_id 
	--,group_id --or assign to group
	,comment_body_html --(for html body)
	--,comment_body (for plain text)
	,comment_public
	,tags
	,custom_fields)
VALUES(
  'Test Ticket Subject - From email'
, 'new' --new, solved, closed
, 'fromsomeuser@abc.com' --from email
, 'Bob Smith' --submitter name needed if its new user
, 18590685428 --assign to agent id
--,123435454 --or use group id if not assignee 
, 'This is <b>html body</b>' --markup also supported
--, 'This is plain text'
, 1 --1=public, 0=private 
, '["tag1","tag2"]' 
  --below json can be obtained using select custom_fields from tickets where id=1234
, '[
  {
    "id": 56608448,
    "value": "1122"
  },
  {
    "id": 57385967,
    "value": "ORD-12345"
  }
]'
)

BULK Create tickets (BULK read / write from external source)    [Read more...]

This examples shows how to use SOURCE clause to read data from MS SQL Server (or other external system) and send data to Zendesk using Bulk API

INSERT INTO Tickets_BULK 
SOURCE(
  'MSSQL' --ODBC or OLEDB
  ,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
  ,'select ''Test Subject#1'' as subject,''new'' as status,''this is description#1'' as comment_body from Projects'
)

Delete a ticket by Id    [Read more...]

DELETE FROM Tickets WHERE Id=111

Delete multiple by tickets by Id list - BULK (comma seperated - max 100 ids)    [Read more...]

DELETE FROM Tickets_Bulk WHERE [$$ticket_ids]='111,222,333'

Update ticket by Id    [Read more...]

Update Tickets 
SET subject='Test ticket subject'
  , tags='["tag1","tag2"]' 
  --, additional_tags ='["tag1","tag2"]' --tags you like to remove
  --, remove tags='["tag1","tag2"]'
  , status='pending' --new, solved, closed
  --below json can be obtained using select custom_fields from tickets where id=1234
  , custom_fields='[
  {
    "id": 10000,
    "value": "some value for prop1"
  },
  {
    "id": 10001,
    "value": "some value for prop2"
  }
]'
Where Id = 1234

Update exising ticket with private comment    [Read more...]

Update Tickets 
SET comment_body='Closing this ticket'
  , comment_public = 0 --or 1
  , status='solved' --pending, new, closed
  --, comment_body_html='Closing <b>this</b> ticket'
  --, comment_author_id=123545   
Where Id = 1234

Update exising ticket with HTML body    [Read more...]

Update Tickets 
SET comment_body_html='Closing <b>this</b> ticket'
  , status='solved' --pending, new, closed
  --, comment_author_id=123545   
  --, comment_public = 0 --or 1  
Where Id = 1234

Update ticket with Add or remove tags    [Read more...]

Update ticket with Add new tags or remove tags. Adding / removing tags available via special field names only in BULK mode so you must use Tickets_BULK table.

Update Tickets_Bulk 
SET subject='New subject'
  , additional_tags ='["new-tag1","new-tag2"]' --//add some tags
  --, remove_tags='["old-tag1","old-tag2"]' --//removes some tags
  --, tags='["tag1","tag2"]' --//overwrite all tags
  , status='pending' --new, solved, closed
Where Id = 1234

Update multiple tickets - (BULK read / write from external source)    [Read more...]

This examples shows how to perform bulk update using SOURCE clause. It reads data from external system (in this example MS SQL Server) and sends data to Zendesk using Bulk API

UPDATE Tickets_BULK 
SOURCE(
  'MSSQL' --ODBC or OLEDB
  ,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
  ,'select 104897 as Id, ''Test Subject#1-updated-bulk-demo'' as subject,''new'' as status
    UNION 
    select 104898 as Id, ''Test Subject#2-updated-bulk-demo'' as subject,''new'' as status'
)

Delete multiple tickets - (BULK read / write from external source)    [Read more...]

This examples shows how to perform bulk delete using SOURCE clause. It reads data from external system (in this example MS SQL Server) and sends data to Zendesk using Bulk API

DELETE FROM Tickets_BULK 
SOURCE(
  'MSSQL' --ODBC or OLEDB
  ,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
  ,'select 104897 as Id 
    UNION 
    select 104898 as Id'
)

Create a new ticket using Raw JSON Body approach    [Read more...]

INSERT INTO Tickets(_rawdoc_) 
VALUES(
  '{
      "subject": "Test ticket #1",    
      "comment": {
        "body": "Test ticket #1"
      },
      "priority": "urgent"
    }'
)

Update an existing ticket using Raw JSON Body approach    [Read more...]

UPDATE Tickets
SET _rawdoc_ =
  '{
      "subject": "Test ticket #1",    
      "comment": {
        "body": "Test ticket #1"
      },
      "priority": "urgent"
    }'
WHERE Id=1234

Create multiple ticket(s) using a RAW JSON body (single or multiple)    [Read more...]

INSERT INTO Tickets_Bulk(_rawdoc_) 
VALUES(
  '[
    {
      "subject": "Test ticket #1",    
      "comment": {
        "body": "Test ticket #1"
      },
      "priority": "urgent"
    },
    {
      "subject": "Test ticket #2",    
      "comment": {
        "body": "This is a comment for #2"
      },
      "priority": "normal"
    }
  ]'
)

Create User    [Read more...]

Create a new user for specified email id and other information. If user with same email exists then call fails.

INSERT INTO Users
(
 name
,email
,organization_id
,phone
,default_group_id
,locale
,moderator
,skip_verify_email
,only_private_comments
,signature
,tags
,time_zone
,role
,external_id
,alias
,details
,notes
,remote_photo_url
,user_fields
)
VALUES(
   'Bob Walton'
  ,'bob@abc.com'
  ,5397098432795
  ,'111-222-3333'
  ,114094762733
  ,'en-US'
  ,'false'
  ,'true' --true=do not send verify account email
  ,1 --user can put only private comments
  ,'Best regards, Support Team' --Only agents and admins can have signatures
  ,'["paid","trial","solved"]' 
  ,'America/New_York'
  ,'end-user' --agent or admin 
  ,'zcrm_1558554000052161270'
  ,'some alias'
  ,'some details'
  ,'some notes'
  ,'https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png' --this does not work in INSERT (works only in UPDATE/UPSERT for now)
  ,'{"birthdate": "1981-01-23", "gender": "M"}'
)

Update User    [Read more...]

UPDATE Users
SET name='Sam Walton'
  ,email='sam@abc.com'
  ,organization_id=5397098432795
  ,phone='111-222-3333'
  ,default_group_id=114094762733
  ,locale='en-US'
  ,skip_verify_email='true' --do not send verify account email
  ,moderator='false'
  ,only_private_comments=1 --user can put only private comments
  ,signature='Best regards, Support Team' --Only agents and admins can have signatures
  ,tags='["paid","trial","solved"]' 
  ,time_zone='America/New_York'
  ,role='end-user'
  ,external_id='zcrm_1558554000052161269'
  ,alias='some alias'
  ,details='some details'
  ,notes='some notes'
  ,remote_photo_url='https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png'
  ,user_fields='{"birthdate": "1981-01-23", "gender": "M"}'
Where id=21811221397915

Upsert User (Create or Update)    [Read more...]

Creates a user if the user does not already exist, or updates an existing user identified by e-mail address or external ID.

INSERT INTO Users
(
 name
,email
,organization_id
,phone
,default_group_id
,locale
,moderator
,skip_verify_email
,only_private_comments
,signature
,tags
,time_zone
,role
,external_id
,alias
,details
,notes
,remote_photo_url
,user_fields
)
VALUES(
   'Bob Walton'
  ,'bob@abc.com'
  ,5397098432795
  ,'111-222-3333'
  ,114094762733
  ,'en-US'
  ,'false'
  ,'true' --true=do not send verify account email
  ,1 --user can put only private comments
  ,'Best regards, Support Team' --Only agents and admins can have signatures
  ,'["paid","trial","solved"]' 
  ,'America/New_York'
  ,'end-user' --agent or admin 
  ,'zcrm_1558554000052161270'
  ,'some alias'
  ,'some details'
  ,'some notes'
  ,'https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png' --this does not work in INSERT (works only in UPDATE/UPSERT for now)
  ,'{"birthdate": "1981-01-23", "gender": "M"}'
)

Delete User    [Read more...]

DELETE FROM Users Where id=21855694556443 --it doesnt delete user from system but only changes active flag

Search for user with email id    [Read more...]

SELECT *
FROM get_search
WITH(
	  query='type:user email:bob@abc.com'
)

Create Organization    [Read more...]

Create a new organization for specified email id and other information. If organization with same email exists then call fails.

INSERT INTO Organizations
(
	 name
	,external_id
	,group_id 
	,tags
	,details
	,notes
	,organization_fields
	,domain_names
	,shared_tickets
	,shared_comments
)
VALUES(
	'Abc Inc'
	,'zcrm_1558554000052161270'  --external_id
	,114094762733  
	,'["paid","trial","solved"]' 
	,'some details'
	,'some notes'
	,'{"startdate": "1981-01-23", "revenue": 12000000.50, "somenumber": 1235678}'
	,'["aaa.com", "bbb.com"]'
	,'false'
	,'false'
)

Update Organization    [Read more...]

UPDATE Organizations
SET  name='Abc Inc'
	,external_id='zcrm_1558554000052161270'
	,group_id=114094762733 
	,tags='["paid","trial","solved"]'
	,details='some details'
	,notes='some notes'
	,organization_fields='{"startdate": "1981-01-23", "revenue": 12000000.50, "somenumber": 1235678}'
	,domain_names='["aaa.com", "bbb.com"]'
	,shared_tickets='false'
	,shared_comments='false'
Where id=21863188631451

Upsert Organization (Create or Update)    [Read more...]

Creates an organization if the organization does not already exist, or updates an existing organization identified by e-mail address or external ID.

UPSERT INTO Organizations
(
	 name
	--id or external_id can be supplied for UPSERT
	,id 
	--or--
	,external_id
	 
	,group_id 
	,tags
	,details
	,notes
	,organization_fields
	,domain_names
	,shared_tickets
	,shared_comments
)
VALUES(
	'Abc Inc'
	,1234567 --id
	--or--
	,'zcrm_1558554000052161270'  --external_id
	
	,114094762733  
	,'["paid","trial","solved"]' 
	,'some details'
	,'some notes'
	,'{"startdate": "1981-01-23", "revenue": 12000000.50, "somenumber": 1235678}'
	,'["aaa.com", "bbb.com"]'
	,'false'
	,'false'
)

Delete Organization    [Read more...]

DELETE FROM Organizations Where id=21855694556443

Search for an organization with a specified name    [Read more...]

SELECT *
FROM get_search
WITH(
	  query='type:organization "Abc"'
)

Bulk Import Mode for Users or Organizations    [Read more...]

This example shows how to upsert in bulk mode from external data and import into Zendesk. We used Microsoft SQL Server as source system in below example with static value query (just one row) but it can be any number of rows.

UPSERT INTO Organizations
SOURCE('MSSQL' --ODBC
, 'Data Source=localhost;Initial Catalog=test;Integrated Security=true'

--For bulk input, map columns in External Query (Must use alias column name to match INSERT command Input Column names - see help file)
--If parameter value not same for all input rows then you can prefix some column with $$ to map as parameter (i.e. $$MyParam1)
--'ODBC', 'Driver={ZappySys CSV Driver};DataPath=C:\AccountsToInsert.csv'
--'ODBC', 'DSN=MyDSN'
--'OLEDB', 'Provider=SQLNCLI11;Server=localhost,1433;Database=tempdb;Trusted_Connection=yes;'

, 'select
      21863188631451 as id
    , ''Abc Inc'' as name
	,''zcrm_1558554000052161270'' as external_id
	,114094762733  as group_id
	,''["paid","trial","solved"]'' as tags
	,''some details'' as details
	,''some notes'' as notes
	,''{"startdate": "1981-01-23", "revenue": 12000000.50, "somenumber": 1235678}'' as organization_fields
	,''["aaa.com", "bbb.com"]'' domain_names
	,''false'' as shared_tickets
	,''false'' as shared_comments
')

Other App Integration scenarios for Zendesk

Other Connectors for JAVA


Download Zendesk Connector for JAVA Documentation 

  • How to connect Zendesk in JAVA?

  • How to get Zendesk data in JAVA?

  • How to read Zendesk data in JAVA?

  • How to load Zendesk data in JAVA?

  • How to import Zendesk data in JAVA?

  • How to pull Zendesk data in JAVA?

  • How to push data to Zendesk in JAVA?

  • How to write data to Zendesk in JAVA?

  • How to POST data to Zendesk in JAVA?

  • Call Zendesk API in JAVA

  • Consume Zendesk API in JAVA

  • Zendesk JAVA Automate

  • Zendesk JAVA Integration

  • Integration Zendesk in JAVA

  • Consume real-time Zendesk data in JAVA

  • Consume realtime Zendesk API data in JAVA

  • Zendesk ODBC Driver | ODBC Driver for Zendesk | ODBC Zendesk Driver | SSIS Zendesk Source | SSIS Zendesk Destination

  • Connect Zendesk in JAVA

  • Load Zendesk in JAVA

  • Load Zendesk data in JAVA

  • Read Zendesk data in JAVA

  • Zendesk API Call in JAVA