ExpandedToggleIcon        Connection Dialog

The following connection options are required:

1.Host - your Zendesk subdomain name;
2.Email - the user email to login with;
3.API Token - an automatically generated REST API authentication token that is used for connecting to Zendesk.


To find the API Token, perform the following steps:

1.Log in to your Zendesk account
2.In your profile, click the Admin button on the left.
3.Under Channels click API.
4.You should see your token under Active API Tokens.


In addition to the required options, Advanced connection options may be set for more fine connection tuning.


ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:




API Token

An automatically generated key that is used for connecting to Zendesk.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.


The user email to login with.

Failover Retries

The number of retry attempts to automatically re-run a command before displaying an error message in case when the command failed because of an error that may be temporary.

Incremental Export

Determines whether to use Incremental Export API for Zendesk tickets.

Note that standard Zendesk API don't support working with archived tickets (a ticket goes to archived 120 days after it is closed). If you want to work with all tickets, including archived, set this parameter to True.

Besides, Incremental Export API supports filtering tickets by their Updated field natively, so if you use this field in filters, setting this parameter to True provides better performance. However, Incremental Export API doesn't support native filtering by other ticket fields, like Status, Type, Priority, RequesterId, OrganizationId, etc., which is supported by the standard Zendesk API. So if you use these fields in filters, don't set this parameter to True.

Local SQL Engine

Determines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to Zendesk API calls or to show an error message.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.


If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.


Indicates whether the connection is read-only (allows only SELECT statements).


The API Path - the path where all XML requests to Zendesk should be sent.

Token Server

Not used for Zendesk.

Use Custom Fields

Determines whether to read custom fields for the Ticket, Request, View, User, and Organization objects.

Use Search API

Allows users to disable using Search API to query data from Zendesk. Note that in this case you can retrieve only tickets for past 120 days.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered in Excel are considered UTC dates when saving them to the data source.