Zendesk

ExpandedToggleIcon        Connection Dialog

To be successfully connected to Zendesk, first select the appropriate Authentication Type from the following authentication methods possible: Basic, APIToken and AccessToken.

The following connection parameters are required for Basic (email/password) authentication:

1.Subdomain - The URL address of your Zendesk domain. This parameter specifies a tenant-specific set of Zendesk API endpoints.
2.Password - The user password to login to your Zendesk account.
3.Email - The user email used for logging in to your Zendesk account.

 

You can also access Zendesk using an alternative type of authentication method - APIToken, by specifying the following parameters:

1.Subdomain - The URL address of your Zendesk domain. This parameter specifies a tenant-specific set of Zendesk API endpoints.
2.APIToken - An an auto-generated unique key allowing connection to Zendesk.
3.Email - The user email used for logging in to your Zendesk account.

To be able to view Information on active API tokens you need to sign in to your Zendesk account. If you don't have a valid API token and need to create one.

For creating a new API token, follow the steps below:

1.Sign up or sign in to your Zendesk account on the website log in page.
2.Go to Admin Center and click Apps and integrations, the last item on the sidebar to the left of the main window, and select APIs > Zendesk API.
3.Click the Add API token button to the right of Active API tokens. Now, the token is generated and displayed on the screen.
4.Copy the token and paste it somewhere secure. When you click Save to close the current window, the full API token will never be displayed again.
5.Click Save to return to the Zendesk API page.

Keep in mind, that if you click the generated token to reopen it, a truncated version of the token is displayed.

 

For successful connection using the AccessToken (OAuth) authentication type, specify the following connection parameters:

1.Subdomain - The URL address of your Zendesk domain. This parameter specifies a tenant-specific set of Zendesk API endpoints.
2.AccessToken - An OAuth access token used for Zendesk authorization and accessing your Zendesk account data.

Note that at present AccessToken (OAuth) authentication type is not supported.

 

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

Stores the automatically generated OAuth access token used for Zendesk authorization and accessing Zendesk account data.

API Token

Specifies an automatically generated unique key allowing connection to user's Zendesk account.

Authentication Type

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

Client Id

Specifies the client ID of a custom OAuth app that you can register for Zendesk. The value is used for the AccessToken (OAuth) authentication type.

Client Secret

Specifies the client secret of a custom OAuth app that you can register for Zendesk. The value is used for the AccessToken (OAuth) authentication type.

Connection Lifetime

Specifies the time interval (in seconds) during which the connection is kept alive. The default value is 0 (in seconds).

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 interval (in seconds) to wait for establishing a connection to the server before terminating the attempt and generating an error. The default value is 60.

Describe Custom Objects

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

Failover Retries

Specifies the number of retries to perform a command if it fails because of the exception, which indicates that the reason of a failure may be temporary. The default value is 7.

Incremental Export

Determines, whether to use the incremental export API for quering tickets from Zendesk. The default value is False.

Initialization Command

Specifies a database-specific command executed right after opening the connection.

Legacy Describe Custom Objects

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

Local SQL Engine

Enables local SQL processing, that allows using more standard SELECT statement features. This parameter is enabled by default, so that the default value is True.

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

Shortens too long names (e.g. table or column names) exceeding the 63-character limit. If the name is too long, the initial 51 characters are retained and an underscore and a hash are added to the name.

Password

Specifies the user password used for signing in to your Zendesk account. This parameter value is required for Basic (email/password) authentication type.

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

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

Proxy Host

Specifies the name or IP address of the proxy server to connect to, 'Proxy Host=X' in the connection string.

Proxy Password

Specifies the password for the proxy server account, 'Proxy Password=X' in the connection string.

Proxy Port

Specifies the port number of the proxy server to connect to, 'Proxy Port=X' in the connection string. The default value is 3128.

Proxy User

Specifies the proxy server account name, 'Proxy User=X' in the connection string.

Readonly

Indicates whether the connection is read-only (allows only SELECT statements). The default value is False.

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 command to execute when the connection is opened for the first time and not executed when the connection is taken from the pool.

Server

Provides basic URL to user's Zendesk account.

Subdomain

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

Token Server

Specifies the location where new tokens are stored between sessions. This location serves as a storage place for access/refresh tokens, which are automatically refreshed by the provider as soon as the current token expires. You can specify the URL to the token server or the path to a file or a registry key, where temporary tokens will be stored.

Use Custom Fields

Determines whether user-defined custom fields for specific objects will be processed in Zendesk, allowing reading and editing custom fields data. The default value is True.

Use Search API

Determines whether to use Search API for querying data from Zendesk. The default parameter value is True. By setting this parameter to False, data querying from Zendesk will be disabled.

UTC Dates

Converts dates to UTC format during import if set to True, and treats the date values entered by the user (in SELECT statements, etc.) as UTC dates when sending them to the data source.