Zendesk Connector for SSIS

Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.

In this article you will learn how to quickly and efficiently integrate Zendesk data in SSIS without coding. We will use high-performance Zendesk Connector to easily connect to Zendesk and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Connect to Zendesk in other apps
Zendesk Connector Connect Zendesk in SQL Server SQL Server
Connect to Zendesk in SQL Server
Zendesk Connector Connect Zendesk in Power BI Power BI
Connect to Zendesk in Power BI
Zendesk Connector Connect Zendesk in SSRS SSRS
Connect to Zendesk in SSRS
Zendesk Connector Connect Zendesk in Informatica Informatica
Connect to Zendesk in Informatica
Zendesk Connector Connect Zendesk in MS Access MS Access
Connect to Zendesk in MS Access
Zendesk Connector Connect Zendesk in MS Excel MS Excel
Connect to Zendesk in MS Excel
Zendesk Connector Connect Zendesk in SSAS SSAS
Connect to Zendesk in SSAS
Zendesk Connector Connect Zendesk in C# C#
Connect to Zendesk in C#
Zendesk Connector Connect Zendesk in Python Python
Connect to Zendesk in Python
Zendesk Connector Connect Zendesk in JAVA JAVA
Connect to Zendesk in JAVA
Zendesk Connector Connect Zendesk in Tableau Tableau
Connect to Zendesk in Tableau
Zendesk Connector Connect Zendesk in SAP Crystal Reports SAP Crystal Reports
Connect to Zendesk in SAP Crystal Reports
Zendesk Connector Connect Zendesk in Azure Data Factory (Pipeline) Azure Data Factory (Pipeline)
Connect to Zendesk in Azure Data Factory (Pipeline)
Zendesk Connector Connect Zendesk in Azure Data Factory (SSIS) Azure Data Factory (SSIS)
Connect to Zendesk in Azure Data Factory (SSIS)
Zendesk Connector Connect Zendesk in Talend Studio Talend Studio
Connect to Zendesk in Talend Studio
Zendesk Connector Connect Zendesk in UiPath UiPath
Connect to Zendesk in UiPath
Zendesk Connector Connect Zendesk in PowerShell PowerShell
Connect to Zendesk in PowerShell
Zendesk Connector Connect Zendesk in ODBC ODBC
Connect to Zendesk in ODBC

Video Tutorial - Integrate Zendesk data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Zendesk integration in SSIS
  • How to configure the connection for Zendesk
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Zendesk in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Zendesk in SSIS (Export data)

In this section we will learn how to configure and use Zendesk Connector in API Source to extract data from Zendesk.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom

    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Zendesk Connector from Popular Connector List or press Search Online radio button to download Zendesk Connector. Once downloaded simply use it in the configuration:

    Zendesk
    Zendesk Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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 reference]

    Please refer to below API reference (external site) link for Token Authentication [Http]

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


    Configuring authentication parameters
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

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

    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


    Configuring authentication parameters
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

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

    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.


    Configuring authentication parameters
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - 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.
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Zendesk using Zendesk Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Zendesk and load into target

Write data to Zendesk using SSIS (Import data)

In this section we will learn how to configure and use Zendesk Connector in the API Destination to write data to Zendesk.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Zendesk integration in SSIS
  • How to configure connection for Zendesk
  • How to write or lookup data to Zendesk
  • Features about SSIS API Destination
  • Using Zendesk Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Zendesk in the API Source to POST data to the Zendesk.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - 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.
    API Destination - New Connection

  4. Use a preinstalled Zendesk Connector from Popular Connector List or press Search Online radio button to download Zendesk Connector. Once downloaded simply use it in the configuration:

    Zendesk
    Zendesk Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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 reference]

    Please refer to below API reference (external site) link for Token Authentication [Http]

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


    Configuring authentication parameters
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

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

    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


    Configuring authentication parameters
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

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

    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.


    Configuring authentication parameters
    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 RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - 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.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - 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.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Zendesk API call using ZappySys Zendesk Connector

    Execute Package - Reading data from API Source and load into target

Load Zendesk data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Zendesk data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table

  9. Click OK to save the configuration.

  10. Run the package and Zendesk data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target

  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Advanced topics

Actions supported by Zendesk Connector

Zendesk Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 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) Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option Value
now now
now-5h now-5h
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Exclude Deleted Whether or not you'd like to exclude deleted tickets from the response
Option Value
true true
false false
Page Size (Default 1000) Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
 Read Organizations (Incremental) changed after a specified date
Get a list of organizations changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch.    [ Read more... ]
Parameter Description
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option Value
now now
now-5h now-5h
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Exclude Deleted Whether or not you'd like to exclude deleted tickets from the response
Option Value
true true
false false
Page Size (Default 1000) Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
 Read Ticket Events (Incremental) changed after a specified date
Returns a list of ticket events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch.    [ Read more... ]
Parameter Description
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option Value
now now
now-5h now-5h
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
 Read Ticket Metric Events (Incremental) changed after a specified date
Get a list of Ticket Metric Events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch.    [ Read more... ]
Parameter Description
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)
Option Value
now now
now-5h now-5h
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Exclude Deleted Whether or not you'd like to exclude deleted tickets from the response
Option Value
true true
false false
Page Size (Default 1000) Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.
 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) using either raw file data (i.e., POST raw file data) or send data using the multi-part encoding method (i.e. Content-Type: multipart/form-data). A multi-part request allows you to mix key/value pairs and upload files in the same request. On the other hand, raw upload allows only a single file to be uploaded (without any key/value data). ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload a single file in raw mode, check this option and specify the full file path starting with the @ 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 in the RequestData field (i.e., Body). Each key/value pair should be entered on a new line, and key/value are separated using an equal sign (=). Leading and trailing spaces are ignored, and blank lines are also ignored. If a field value contains any special character(s), use escape sequences (e.g., for NewLine: \r\n, for Tab: \t, for at (@): @). When the value of any field starts with the at sign (@), it is automatically treated as a file you want to upload. By default, the file content type is determined based on the file extension; however, you can supply a content type manually for any field using this format: [YourFileFieldName.Content-Type=some-content-type]. By default, file upload fields always include Content-Type in the request (non-file fields do not have Content-Type by default unless you supply it manually). If, for some reason, you don't want to use the Content-Type header in your request, then supply a blank Content-Type to exclude this header altogether (e.g., SomeFieldName.Content-Type=). In the example below, we have supplied Content-Type for file2 and SomeField1. All other fields are using the default content type. See the example below 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 start with multipart/ or it 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
Option Value
No filter
Example1 $.store.books[*]
Example2 (Sections Under Books) $.store.books[*].sections[*]
Example3 (Equals) $.store.books[?(@author=='sam')]
Example4 (Equals - Any Section) $..[?(@author=='sam')]
Example5 (Not Equals - Any Section) $..[?(@author!='sam')]
Example6 (Number less than) $.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )]
Example8 (Regular Expression - Does Not Contain Pattern) $.store.books[?(@author=~ /^((?!sam|bob).)*$/ )]
Example9 (Regular Expression - Exact Pattern Match) $.store.books[?(@author=~ /^sam|bob$/ )]
Example10 (Regular Expression - Starts With) $.store.books[?(@author=~ /^sam/ )]
Example11 (Regular Expression - Ends With) $.store.books[?(@author=~ /sam$/ )]
Example12 (Between) $.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )]
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
 Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [ 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
IsMultiPart Set this option if you want to upload file(s) using either raw file data (i.e., POST raw file data) or send data using the multi-part encoding method (i.e. Content-Type: multipart/form-data). A multi-part request allows you to mix key/value pairs and upload files in the same request. On the other hand, raw upload allows only a single file to be uploaded (without any key/value data). ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload a single file in raw mode, check this option and specify the full file path starting with the @ 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 in the RequestData field (i.e., Body). Each key/value pair should be entered on a new line, and key/value are separated using an equal sign (=). Leading and trailing spaces are ignored, and blank lines are also ignored. If a field value contains any special character(s), use escape sequences (e.g., for NewLine: \r\n, for Tab: \t, for at (@): @). When the value of any field starts with the at sign (@), it is automatically treated as a file you want to upload. By default, the file content type is determined based on the file extension; however, you can supply a content type manually for any field using this format: [YourFileFieldName.Content-Type=some-content-type]. By default, file upload fields always include Content-Type in the request (non-file fields do not have Content-Type by default unless you supply it manually). If, for some reason, you don't want to use the Content-Type header in your request, then supply a blank Content-Type to exclude this header altogether (e.g., SomeFieldName.Content-Type=). In the example below, we have supplied Content-Type for file2 and SomeField1. All other fields are using the default content type. See the example below 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 start with multipart/ or it will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair

Conclusion

In this article we showed you how to connect to Zendesk in SSIS and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Zendesk, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Zendesk Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Zendesk Connector for SSIS Documentation

More integrations

Other connectors for SSIS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Zendesk

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications
Download Zendesk Connector for SSIS Documentation

  • How to connect Zendesk in SSIS?

  • How to get Zendesk data in SSIS?

  • How to read Zendesk data in SSIS?

  • How to load Zendesk data in SSIS?

  • How to import Zendesk data in SSIS?

  • How to pull Zendesk data in SSIS?

  • How to push data to Zendesk in SSIS?

  • How to write data to Zendesk in SSIS?

  • How to POST data to Zendesk in SSIS?

  • Call Zendesk API in SSIS

  • Consume Zendesk API in SSIS

  • Zendesk SSIS Automate

  • Zendesk SSIS Integration

  • Integration Zendesk in SSIS

  • Consume real-time Zendesk data in SSIS

  • Consume real-time Zendesk API data in SSIS

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

  • Connect Zendesk in SSIS

  • Load Zendesk in SSIS

  • Load Zendesk data in SSIS

  • Read Zendesk data in SSIS

  • Zendesk API Call in SSIS