Zendesk Connector for Informatica

In this article you will learn how to integrate Zendesk data in Informatica without coding in just a few clicks (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 Informatica. Follow the steps below to see how we would accomplish that.

Download Documentation

The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.

If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.

Connect to Zendesk in other apps

Connect to Zendesk in SSIS

Connect to Zendesk in SQL Server

Connect to Zendesk in Power BI

Connect to Zendesk in SSRS

Connect to Zendesk in MS Access

Connect to Zendesk in MS Excel

Connect to Zendesk in SSAS

Connect to Zendesk in C#

Connect to Zendesk in Python

Connect to Zendesk in JAVA

Connect to Zendesk in Tableau

Connect to Zendesk in SAP Crystal Reports

Connect to Zendesk in Azure Data Factory (Pipeline)

Connect to Zendesk in Azure Data Factory (SSIS)

Connect to Zendesk in Talend Studio

Connect to Zendesk in UiPath

Connect to Zendesk in PowerShell

Connect to Zendesk in ODBC

NOTE: If you need to consume API which is not listed on connector library page then please refer to the below article links. It talks about how to read / write pretty much any API and not just Zendesk API. It explains various API tips / tricks using our other Universal Drivers not mentioned in this article (i.e. ZappySys JSON / XML and CSV Drivers).
How to read API data in Informatica (Call JSON / XML SOAP Service)
How to write data to API (POST) in Informatica (Call JSON / XML SOAP Service)

Introduction

JSON / REST API is becoming more and more popular each day as everyone embrace cloud-centric services. This article is primarily focused on Informatica users who want to access Zendesk data or may be other API Integration in Informatica. However many tips and techniques described in this article will help you to understand how to integrate Zendesk / XML SOAP / JSON / REST API in other ETL / Reporting apps such as Tableau, Power BI, SSRS, Talend, Excel and many more.

After going through this article you will learn how to Read Zendesk / JSON / REST API data in Informatica and understand the concept of JSON / REST API. We will go through many screenshots and step-by-step examples to demonstrate Zendesk or REST API integration in Informatica PowerCenter.

XML / JSON can come from a local file or REST API service (internal or public) so we will include both examples in this article (i.e. Read JSON files in Informatica, Import REST API in Informatica). So let’s get started. Next article will focus on how to write data to API in Informatica (POST / PUT data)

Requirements

This article assumes that you have full filled following basic requirements.

Download Install ZappySys ODBC PowerPack (API Driver for Zendesk included)
Install Informatica PowerCenter Client Tools (e.g. Workflow and Mapping Designers)
Access to a Relational database such as SQL Server (or use any of your choice e.g. Oracle, MySQL, DB2 ). If nothing available then you can use flat file target.

High level Steps for Import Zendesk data using Informatica (Read Zendesk API data)

Before we dive deep to learn how to load Zendesk data in Informatica (i.e. Zendesk to SQL Table), Here the summary of high-level steps you need to perform to import Zendesk in Informatica (same steps for Import JSON / XML / REST API).

Download and Install ZappySys API Driver (for connecting to Zendesk)
Create ODBC DSN using ZappySys API driver and choose Zendesk Connector during Wizard
Create Relational > ODBC Connection in Informatica Workflow designer (Point to DSN we created in the previous step)
Import Zendesk Source Definition in the Informatica Mapping Designer > Sources Tab
Import Target Table Definition in the Informatica Mapping Designer > Targets Tab
Create source to target mapping in Mappings tab
Save mapping (name m_API_to_SQL_Load )
Create Session using the mapping we created in the previous step
Save Workflow and execute to load Zendesk data into SQL Table. Verify your data and log.
Loading Zendesk data to SQL Table in Informatica (Import REST API or JSON Files)

Video Tutorial – Read any API / JSON data in Informatica (Load Zendesk to SQL Table)

Below video is not about Zendesk API but its showing API access in general (for any API). By watching following ~5 min video can learn steps listed in this article to load JSON API data into SQL Server Table using ZappySys JSON Driver. You can go though full article to learn many useful details not covered in this video.

Watch this video on YouTube

Getting Started – Import Zendesk to SQL Server in Informatica

Now let’s get started. For example purpose, we will read data from Zendesk and load data into SQL Server Table using Informatica Workflow.

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Zendesk using Informatica we first need to create a DSN (Data Source) which will access data from Zendesk. We will later be able to read data using Informatica. Perform these steps:

Install ZappySys ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User Data Source (User DSN) based on ZappySys API Driver

ZappySys API Driver

You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
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

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.

Token Authentication [Http]

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...

OAuth Authentication [OAuth]

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...

UserID/Password Authentication (2FA must be OFF) [Http]

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...

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:
Click OK to finish creating the data source.

Video instructions

Watch this video on YouTube

Create Connection in Informatica Workflow Designer

Once you create DSN using API Driver our next step is to define a connection for Zendesk source in Informatica PowerCenter Workflow designer.

Open Workflow designer [W] icon
Goto Connections > Relational

Create a new connection for Zendesk in Informatica
Click New and select ODBC

Select ODBC connection type in Informatica (Using ZappySys API ODBC DSN)
Now on the ODBC connection setup enter connection name, some fake userid / password (this is a required field but its ignored by JSON Driver)
In the Connection String field enter the exact same name of DSN (Open ODBC Data Sources UI to confirm)

Configure Zendesk connection in Informatica for REST API – Using ZappySys API Driver
Click OK to close the connection properties.

That’s it. Now we ready to move to next step (define source and target in Mapping Designer).

Import Zendesk Source Definition in Informatica Mapping Designer

Now let’s look at steps to import Zendesk table definition.

Open Informatica Mapping Designer (Click [D] icon)
Click on Source Icon to switch to Sources designer
From the top menu > Click on Sources > Import from Database …

Import Zendesk Source definition in Informatica Mapping Designer (JSON file or REST API)
Select ODBC data source from the dropdown (Find out DSN we created earlier to use as JSON Source)
Click Connect button to get a list of tables. Any array node is listed as a table. Also, you will see array node with parent columns (e.g. value_with_parent). You may get some warning like below but they are harmless so just ignore by clicking OK.

DLL name entry missing from C:\Informatica\PowerCenter8.6.1\client\bin\powrmart.ini Section = ODBCDLL Entry = ZappySys JSON Driver
—————————————————-
Using EXTODBC.DLL to support ZappySys JSON Driver. For native support of ZappySys JSON Driver make an entry in the .ini file.

Select Zendesk Source Table in Informatica Mapping Designer (JSON file or REST API)
Select Table you wish to get (You can filter rows by custom SQL query. We will see later in this article how to do)
Optionally once table structure is imported you can rename it

Rename imported table definition in Informatica Source Designer
That’s it, we are now ready to perform similar steps to import Target table structure in the next section.

Import SQL Server Target Definition in Informatica Mapping Designer

Now let’s look at steps to import Target table definition (very similar to the previous section, the only difference is this time we will select DSN which points to SQL Server or any other Target Server).

Now lets look at steps to import target table definition in Informatica mapping designer.

In the Mapping Designer, Click on Target Icon to switch to Target designer
From the top menu > Click on Targets > Import from Database …
Select DSN for your Target server (if DSN doesn’t exist then create one by opening ODBC Sources just like we created one for JSON API source (see the previous section about creating DSN).

Import target Table Definition in informatica
Enter your userid , password and Schema name and click Connect to see tables
Select Table name to and click OK import definition.

Import Target SQL Table Definition in Informatica – Select table from the list

Create Source to Target Mapping in Informatica (Import JSON to SQL Server)

Once you have imported source and target table definition, we can create mapping and transformation to load data from JSON to SQL Table.

First open Mapping Designer (Click [D] icon)
Drag JSON Source from sources folder
Drag SQL Table from Targets folder
Map desired columns from Source to target

Define Source to Target mapping for Zendesk to SQL Table load in Informatica
For certain columns you may have to do datatype conversion. For example to convert OrderDate form nstring to DataTime you have to use Expression Transform like below and map it to target. In below example, our JSON has date format (e.g. 2018-01-31 12:00:00 AM ). To import this to DateTime field in SQL server we need to convert it using TO_DATE function. Use double quotes around T to make this format working.
```
TO_DATE(OrderDate,'YYYY-MM-DD H12:MI:SS AM')

 --For ISO use below way
                TO_DATE(OrderDate,'YYYY-MM-DD"T"HH24:MI:SS')
```
Informatica Zendesk to SQL Table Mapping – Datatype conversion (nstring to datetime)
Once you done with mapping save your mapping and name it (i.e. m_Api_To_SQL)
Now lets move to next section to create workflow.

Create Workflow and Session in Informatica

Now the final step is to create a new workflow. Perform following steps to create workflow which with a session task to import JSON data into SQL table.

Open workflow designer by click [W] icon.
Launch new workflow creation wizard by click Workflow top menu > Wizard
name your workflow (e.g. wf_Api_Tp_Sql_Table_Import)

Creating Informatica Workflow – Wizard UI (Import Zendesk data to SQL Table)
Finish the wizard and double-click the Session to edit some default properties.
First change Error settings so we fail session on error (By default its always green)

Fail Informatica Session on error (Zendesk data to SQL Load)
Select JSON connection for Source

Select Zendesk Source Connection in Informatica – Load Zendesk data to SQL Table
Change default Source query if needed. You can pass parameters to this query to make it dynamic.

Modify Zendesk Source SQL query – Pass parameters, change URL, set filter etc
Select Target connection of SQL Target Table

Select SQL Target Connection in Informatica – Load Zendesk data to SQL Table
Save workflow
That’s it. We ready to run our first workflow to load JSON data to SQL.

Execute Workflow and Validate Log in Informatica

Now once you are done with your workflow, execute it to see the log.

Loading JSON data to SQL Table in Informatica (Import REST API or JSON Files)

Loading Zendesk data to SQL Table in Informatica (Import REST API or JSON Files)

POST data to Zendesk in Informatica

There will be a time when you like to send Source data to REST API or SOAP Web Service. You can use below Query for example. For detailed explanation on how to POST data in Informatica check this article.

Video Tutorial – How to POST data to REST API in Informatica

Here is detailed step by step video on REST API POST in informatica PowerCenter

Watch this video on YouTube

Keywords

Advanced topics

Create Custom Stored 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 Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored 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>';
```
That's it now go to Preview Tab and Execute your Stored 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';
```
Let's generate the SQL Server Query Code to make the API call using stored 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''')
```
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.

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.

Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
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'
```
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"
```
Let's generate the SQL Server Query Code to make the API call using stored 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''')
```
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.

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

Records Per Page (Max 100)

Read Tickets (Incremental) changed after a specified date

Get a list of tickets changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [Read more...]

Parameter

Description

Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Exclude Deleted

Whether or not you'd like to exclude deleted tickets from the response

Option	Value
true	true
false	false

Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Read Users (Incremental) changed after a specified date

Get a list of users changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [Read more...]

Parameter

Description

Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Exclude Deleted

Whether or not you'd like to exclude deleted tickets from the response

Option	Value
true	true
false	false

Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Read Organizations (Incremental) changed after a specified date

Get a list of organizations changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [Read more...]

Parameter

Description

Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Exclude Deleted

Whether or not you'd like to exclude deleted tickets from the response

Option	Value
true	true
false	false

Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Read Ticket Events (Incremental) changed after a specified date

Returns a list of ticket events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [Read more...]

Parameter

Description

Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Read Ticket Metric Events (Incremental) changed after a specified date

Get a list of Ticket Metric Events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [Read more...]

Parameter

Description

Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Exclude Deleted

Whether or not you'd like to exclude deleted tickets from the response

Option	Value
true	true
false	false

Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Read Ticket(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
Records Per Page (Max 100)

Read Tickets for User (Requested)

Get all requested tickets for specified user_id [Read more...]

Parameter	Description
User ID
Records Per Page (Max 100)

Read Tickets for User (CCed)

Get all CCed tickets for specified user_id [Read more...]

Parameter	Description
User ID
Records Per Page (Max 100)

Read Tickets for User (Assigned)

Get all assigned tickets for specified user_id [Read more...]

Parameter	Description
User ID
Records Per Page (Max 100)

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...]

Parameter	Description
Records Per Page (Max 100)

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: '2013-04-03T16:02:46Z'.

Read Ticket ActivityStream Details

Lists ticket activity details. [Read more...]

Parameter	Description
activity_id

Search Records - WITH Sorting and Extra Columns (Max 1000 rows)

Search for ticket, user, organization, or group for specified search criteria. Returns max 1000 records based on search criteria (i.e. query) you specify [Read more...]

Parameter

Description

Search Criteria

The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226

Option	Value
Example: Search by Ticket ID	112233
Example: Search by Ticket Status	status
Example: Search by Some Text	SomeText
Example: Search By Status	SomeText
Example: Search by Type and Status	type:ticket status:open
Example: Search by Type and Name	type:user "Jane Doe"
Example: Search by Type and CreationDate	type:organization created< 2015-05-01
Example: Search organizations updated after some date	type:organization updated > 2015-05-01
Example: Search users updated after some date	type:user updated > 2015-05-01
Example: Search By Type and Tag	type:ticket tags:red tags:blue

Sort By

Option	Value
updated_at	updated_at
created_at	created_at
priority	priority
status	status
ticket_type	ticket_type

Sort Order

Option	Value
desc	desc
asc	asc

Extra Columns to Include

You can list email CCs by side-loading users.

Option	Value
Default
users	users

Search Records - NO Sorting (Allows more than 1000 rows)

Search for ticket, user, organization, or group for specified search criteria. Sorting not allowed but you can get more than 1000 records unlike other endpoint for search which supports max 1000 rows but allows sorting if needed. [Read more...]

Parameter

Description

FilterType

Option	Value
ticket	ticket
organization	organization
user	user
group	group

Search Criteria

The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226

Option	Value
Example: Search by Ticket ID	112233
Example: Search by Ticket Status	status
Example: Search by Some Text	SomeText
Example: Search By Status	SomeText
Example: Search by Type and Status	type:ticket status:open
Example: Search by Type and Name	type:user "Jane Doe"
Example: Search by Type and CreationDate	type:organization created< 2015-05-01
Example: Search organizations updated after some date	type:organization updated > 2015-05-01
Example: Search users updated after some date	type:user updated > 2015-05-01
Example: Search By Type and Tag	type:ticket tags:red tags:blue

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=='date')]

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
Example: Search by Some Text	SomeText
Example: Search By Status	SomeText
Example: Search by Type and Status	type:ticket status:open
Example: Search by Type and Name	type:user "Jane Doe"
Example: Search by Type and CreationDate	type:organization created< 2015-05-01
Example: Search organizations updated after some date	type:organization updated > 2015-05-01
Example: Search users updated after some date	type:user updated > 2015-05-01
Example: Search By Type and Tag	type:ticket tags:red tags:blue

Status

Sort order

Option	Value
new	new
open	open
pending	pending
solved	solved
closed	closed

organization_id

cc_id

Read Attachment

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

Records Per Page (Max 100)

Read Organizations (All)

Get a list of all organizations in your account [Read more...]

Parameter	Description
Records Per Page (Max 100)

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	Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter	Enter filter to extract array from response. Example: $.rows[] --OR-- $.customers[].orders[*]. Check your response document and find out hierarchy you like to extract
Headers	Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Zendesk Connector Examples for Informatica 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 (incremental) modified after ceratin date/time [Read more...]

Read tickets modified after ceratin date/time. This is incremental data fetch. 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 in the target. Only choose Update + Insert for Incremental fetch.

SELECT * FROM get_tickets_incr
WITH(
	    start_time='2012-01-31T00:00:00' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time='yesterday' --modified after yesterday
	  --start_time='now-5h' --modified after current time minus 5 hours
	  --start_time='today-60s' --modified after today minus 60 seconds
	  --start_time='weekstart' --modified after weekstart
	  --start_time='monthstart-1d' --modified after month start minus 1 day
	  --start_time='yearstart-1d' --modified after year start minus 1 day
	  --start_time='yearstart+1d' --modified after year start plus 1 day
	  --start_time='yearend+1d' --modified after year end plus 1 day
)

Get all users (incremental) modified after ceratin date/time [Read more...]

Read users modified after ceratin date/time. This is incremental data fetch. 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 in the target. Only choose Update + Insert for Incremental fetch.

SELECT * FROM get_users_incr
WITH(
	    start_time='2012-01-31T00:00:00' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time='yesterday' --modified after yesterday
	  --start_time='now-5h' --modified after current time minus 5 hours
	  --start_time='today-60s' --modified after today minus 60 seconds
	  --start_time='weekstart' --modified after weekstart
	  --start_time='monthstart-1d' --modified after month start minus 1 day
	  --start_time='yearstart-1d' --modified after year start minus 1 day
	  --start_time='yearstart+1d' --modified after year start plus 1 day
	  --start_time='yearend+1d' --modified after year end plus 1 day
)

Get all organizations (incremental) modified after ceratin date/time [Read more...]

Read organizations modified after ceratin date/time. This is incremental data fetch. 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 in the target. Only choose Update + Insert for Incremental fetch.

SELECT * FROM get_organizations_incr
WITH(
	    start_time='2012-01-31T00:00:00' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time='yesterday' --modified after yesterday
	  --start_time='now-5h' --modified after current time minus 5 hours
	  --start_time='today-60s' --modified after today minus 60 seconds
	  --start_time='weekstart' --modified after weekstart
	  --start_time='monthstart-1d' --modified after month start minus 1 day
	  --start_time='yearstart-1d' --modified after year start minus 1 day
	  --start_time='yearstart+1d' --modified after year start plus 1 day
	  --start_time='yearend+1d' --modified after year end plus 1 day
)

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 records using query expression (tickets, organization, users) [Read more...]

SELECT *
FROM get_search --limited to 1000 rows max
--OR
--FROM get_search_export --returns more than 1000 rows but no sorting or extra column allowed
WITH(
       filtertype='', --can be ticket, organization, user, group. If you set here then no need to put in query (e.g. query='type:ticket ...'). This option is ignored for get_search_Export.
	  ,sort_by='updated_at' --created_at, status, priority, ticket_type. This option is ignored for get_search_Export.
	  ,sort_order='asc'  --desc (not valid for get_search_export). This option is ignored for get_search_Export.

    --read this for more information 
	--https://support.zendesk.com/hc/en-us/articles/4408883318554-Searching-users-groups-and-organizations
	--https://support.zendesk.com/hc/en-us/articles/4408886879258-Zendesk-Support-search-reference#topic_crj_yev_uc
	--https://support.zendesk.com/hc/en-us/articles/4408882086298-Searching-tickets
	
      ,query='type:ticket subject:"Upsert Destination"'   --search tickets where subject contains phrase "Upsert Destination" (special characters like comma / dash etc ignored in match)
	--,query='type:ticket 519872'   --search ticket with id 519872
	--,query='type:ticket tags:solved,odbc_powerpack updated>1months' --search tickets where two tags set solved,odbc_powerpack and updated in last one month
	--,query='type:ticket -tags:odbc_powerpack updated>1months' --search tickets where where tags not like odbc_powerpack and updated in last one month
	--,query='type:ticket status<solved created>1months' --search tickets with status not solved and created in last one month
	--,query='type:ticket created:2014-08-01' --search tickets created on 2014-08-01 (UTC)
	--,query='type:ticket created>2014-08-01T10:30:00Z created<2014-08-01T12:00:00Z' --search tickets created between two datetime (UTC time)
	--,query='type:ticket requester:amy@mondocam.com' --search tickets where requester is amy@mondocam.com
	--,query='type:ticket description:defective' --search tickets where decription contains word "defective"
	--,query='type:ticket description:"product is defective"' --search tickets where decription contains phrase  "product is defective"
	--,query='type:ticket priority>low' --search tickets where priority greater than low (e.g. medium or high)"
	
	--,query='ZappySys' --phrase match (no type): anywhere in ticket / organization / user contains ZappySys word - If filtertype parameter supplied then only those type included
	--,query='ZappySys*' --phrase match (no type): wildcard usage
	--,query='type:user "ZappySys"' --search users with term "ZappySys" anywhere in text properties
    --,query='type:user email:"@zappysys"' --search users with term "@ZappySys.com" in email field
	--,query='type:user name:"zappysys"' --search users with term "ZappySys" in name field
	--,query='type:user details:"zappysys"' --search users with term "ZappySys" in details field
    --,query='type:organization "ZappySys LLC"' --phrase match: organization name contains ZappySys LLC
)

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
')

Conclusion

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

More integrations

Other application integration scenarios for Zendesk

SSIS

SQL Server

Power BI

SSRS

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for Informatica

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

FastSpring

Google Drive

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Download Zendesk Connector for Informatica Documentation

Common Searches:

How to connect Zendesk in Informatica?
How to get Zendesk data in Informatica?
How to read Zendesk data in Informatica?
How to load Zendesk data in Informatica?
How to import Zendesk data in Informatica?
How to pull Zendesk data in Informatica?
How to push data to Zendesk in Informatica?
How to write data to Zendesk in Informatica?
How to POST data to Zendesk in Informatica?
Call Zendesk API in Informatica
Consume Zendesk API in Informatica
Zendesk Informatica Automate
Zendesk Informatica Integration
Integration Zendesk in Informatica
Consume real-time Zendesk data in Informatica
Consume real-time Zendesk API data in Informatica
Zendesk ODBC Driver | ODBC Driver for Zendesk | ODBC Zendesk Driver | SSIS Zendesk Source | SSIS Zendesk Destination
Connect Zendesk in Informatica
Load Zendesk in Informatica
Load Zendesk data in Informatica
Read Zendesk data in Informatica
Zendesk API Call in Informatica