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!
Zendesk Connector for SSIS is based on ZappySys API Connector Framework
which is a part of SSIS PowerPack.
It is a collection of high-performance SSIS connectors that enable you
to integrate data with virtually any data provider supported by SSIS, including SQL Server.
SSIS PowerPack supports various file formats, sources and destinations,
including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few
(if you are new to SSIS and SSIS PowerPack, find out more on how to use them).
In this section we will learn how to configure and use Zendesk Connector in API Source to extract data from Zendesk.
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
SSIS ToolBox on left side bar
Solution Explorer and Property Window on right bar
Control flow, data flow, event Handlers, Package Explorer in tab windows
Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
Select New Connection to create a new connection:
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
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.
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]
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]
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]
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
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.
That's it! We are done! Just in a few clicks we configured the call to Zendesk using Zendesk Connector.
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.
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
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.
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.
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
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.
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]
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]
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]
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
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.
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.
That's it; we successfully configured the POST API Call. In a few clicks we configured the Zendesk API call using ZappySys Zendesk Connector
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.
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
Connect your SSIS source component to Upsert Destination.
Double-click on Upsert Destination component to open configuration window.
Start by selecting the Action from the list.
Next, select the desired target connection
or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
Then select a table from the Target Table list
or click New button to create a new table based on the source columns.
Continue by checking Insert and Update options according to your scenario
(e.g. if Update option is unchecked, no updates will be made).
Finally, click Map All button to map all columns
and then select the Key columns to match the columns on:
Click OK to save the configuration.
Run the package and Zendesk data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
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:
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...]
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'.
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
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...]
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...]
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...]
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
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.
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
