Zendesk

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:

 

Option

Description

Access Token

Specifies an OAuth access token used for connecting to Zendesk.

API Token

Specifies an automatically generated key that is used for connecting to Zendesk.

Authentication Type

Specifies the authentication type for connecting to Zendesk: Basic, APIToken, or AccessToken.

Client Id

Specifies the client ID of the OAuth app registered for connecting to Zendesk.

Client Secret

Specifies the client secret of the OAuth app registered for connecting to Zendesk.

Connection Lifetime

Specifies the time span (in seconds), compared against a connection's creation time when it is returned to the pool; the connection is destroyed if this span is exceeded. The default value is 0 (connection always returns to pool).

Connection Timeout

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

Default Command Timeout

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

Describe Custom Objects

Determines whether to retrieve metadata for Zendesk custom objects, allowing the driver to expose their custom fields as columns.

Email

Specifies the user email to login with.

Failover Retries

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

Initialization Command

Specifies a database-specific command to execute after establishing the connection.

Legacy Describe Custom Objects

Determines whether to use the legacy API to retrieve metadata for Zendesk custom objects.

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

Specifies 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

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

NormalizeDbNames

Determines whether database object names are normalized when retrieved from the database.

Password

Specifies the password for the account.

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.

Pooling

Draws the connection from the appropriate pool, or creates and adds it to the appropriate pool, when set to true. This is the default behavior.

Proxy Host

Specifies the host name or IP address of the proxy server.

Proxy Password

Specifies the password for the proxy server account.

Proxy Port

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

Proxy User

Specifies the proxy server account name.

Readonly

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

Refresh Token

Stores the OAuth 2.0 refresh token for Zendesk. The value is used for the AccessToken (OAuth) authentication type.

Run Once Command

Specifies a database-specific command to execute after establishing the connection. Unlike Initialization Command, it is not executed for connections obtained from the connection pool.

Server

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

Subdomain

Specifies the URL address of your Zendesk domain, identifying a tenant-specific set of Zendesk API endpoints.

Token Server

Is 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

Converts dates to UTC format during import when set to True; the date values entered in Excel are then considered UTC dates when saving them to the data source.