Authorization

Follow this guide to create a new Zendesk Support credential that will allow Nexla to authenticate to and exchange data with your Zendesk Support account.

Zendesk Support

Prerequisites

Before creating a Zendesk Support credential, you need to obtain your Zendesk subdomain and authentication credentials from your Zendesk account. Zendesk Support supports two authentication methods: Access Token authentication and Username/Password authentication.

Access Token Authentication

Access Token authentication provides secure, token-based access to the Zendesk Support API. This method requires an API token that can be generated in your Zendesk account settings.

To obtain your Zendesk Access Token, follow these steps:

1. Sign in to your Zendesk account using your administrator credentials.

2. Navigate to Admin > Apps and integrations > APIs > Zendesk API in your Zendesk dashboard.

3. In the Zendesk API settings, locate the Token Access section and click Add API token or Generate new token.

4. Enter a description for the token (e.g., "Nexla Integration") and click Create to generate the API token.

5. Copy the API token value immediately, as it may not be accessible again after you navigate away from the page.

6. Store the API token securely, as you will need it to configure your Nexla credential. The API token is sensitive information and should be kept confidential.

The Access Token is sent in the Authorization header as a Bearer token for all API requests to the Zendesk Support API. If your API token is compromised, you should immediately revoke it in your Zendesk account settings and generate a new one. For detailed information about Zendesk API authentication, see the Zendesk API documentation.

Username/Password Authentication

Username/Password authentication uses your Zendesk account credentials to authenticate API requests. This method can use either your account password or an API token appended to your email address.

To use Username/Password authentication, you need:

1. Zendesk Subdomain: Your Zendesk subdomain (e.g., yourcompany from https://yourcompany.zendesk.com).

2. Username/Email: Your Zendesk account email address. If you're using an API token instead of a password, append /token to your email address (e.g., example@domain.com/token).

3. Password/Token: Your Zendesk account password or API token. If using an API token, use the token value as the password.

For detailed information about Zendesk API authentication, see the Zendesk API documentation.

Create a Zendesk Support Credential

• To create a new Zendesk Support credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Zendesk Support

Credential Name & Description

1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

   Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Zendesk Support Authentication Methods

Zendesk Support supports two authentication methods: Access Token authentication and Username/Password authentication. Select the method that best suits your needs.

Zendesk Support Authentication Methods

Zendesk Access Token

Use Access Token authentication for secure, token-based access to the Zendesk Support API. This method requires an API token generated in your Zendesk account settings.

1. Enter your Zendesk subdomain in the **Zendesk subdomain (https://.zendesk.com)** field. This should be your Zendesk subdomain (e.g., `yourcompany` from `https://yourcompany.zendesk.com`). The subdomain determines which Zendesk instance will be accessed.
2. Select the API type from the **Zendesk Core Client ID** pulldown menu. Choose **Zendesk Core API** for standard Zendesk Support API access, or **Zendesk Chat API** for Zendesk Chat API access. The API type determines which Zendesk API will be used.
3. Select the scope from the **Scope** pulldown menu. Choose **read** for read-only access, or **read write** for read and write access. The scope determines the level of access granted to the API token.
4. Click the **Authorize** button to initiate the OAuth authorization flow. You will be redirected to Zendesk to grant permissions to Nexla. After authorization, the Access Token will be automatically populated in the credential configuration.

Username / Password Authentication

Use Username/Password authentication with your Zendesk account credentials. This method can use either your account password or an API token appended to your email address.

1. Enter your Zendesk subdomain in the **Zendesk subdomain (https://.zendesk.com)** field. This should be your Zendesk subdomain (e.g., `yourcompany` from `https://yourcompany.zendesk.com`). The subdomain determines which Zendesk instance will be accessed.
2. Enter your Zendesk username/email in the **Username/Email** field. This should be your Zendesk account email address. If you're using an API token instead of a password, append `/token` to your email address (e.g., `example@domain.com/token`).
3. Enter your Zendesk password or token in the **Password/Token** field. This should be your Zendesk account password or API token. If using an API token, use the token value as the password.

Save the Credential

1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.