Zendesk connection

Data Integration supports three connection methods for Zendesk:

• Username & API Token
• OAuth
• OAuth 2.0

Prerequisites

Before creating a connection, ensure you have the necessary permissions and access to configure your Zendesk account for API usage.

Zendesk subdomain

In Zendesk, locate your subdomain. For example, if your URL is company.zendesk.com/chat, the subdomain is company.

Username & API Token

To enable API access using a Username & API Token.

Procedure

1. Log in to your Zendesk account.
2. Navigate to the Apps and integration panel.
3. Under APIs, select API configuration.
4. Select the Allow API token access option.

To generate API token

1. Log in to your Zendesk account.
2. Navigate to the Apps and integration panel.
3. Under APIs, select API tokens.
4. Click Add API token. Provide the required details.
5. Click Save to generate the API token.

OAuth connection

To connect to Zendesk using OAuth, you must generate an API access token.

Procedure

1. Log in to Zendesk
2. Navigate to the Settings page.
3. Access API settings
   • Under Channels, select API to open the API settings page.
4. Generate an access token
   • Under the Token Access section, view the active tokens associated with your Zendesk account.
   • To create a new token, click the "+".
5. Copy the token
   • The token will be displayed only once. Copy it for use in Data Integration.

OAuth 2.0 connection

Follow the instructions to create the app and generate the Client ID and Client secret credentials.

note

When filling out the Redirect URLs field in Zendesk, copy the URL below that corresponds to your console's region:

• For the EU console, use: https://eu-west-1.console.rivery.io/api/oauthcallback/zendesk
• For the US console, use: https://console.rivery.io/api/oauthcallback/zendesk
• For the Tel Aviv Region console, use: https://il-central-1.console.rivery.io/api/oauthcallback/zendesk
• For the Australia console, use: https://ap-southeast-2.console.rivery.io/api/oauthcallback/zendesk

Creating a Zendesk connection in Data Integration

1. Navigate to the Data Integration Console.
2. Enter a Connection Name.
3. Select your connection method:
   • Choose either Username & API Token, OAuth, or OAUth 2.0 and provide the required details:
   • Username & API token:
     • Sub Domain: Your account subdomain.
     • Username: The email used to log in to Zendesk app.
     • Password: The password for your Zendesk account.
   • OAuth:
     • Sub Domain: Your account subdomain.
     • Access Token: The token you generated in the OAuth steps.
   • OAuth 2.0:
     • Sub Domain: Your account subdomain.
     • Client Id: The Identifier obtained from your Zendesk app.
     • Client Secret: The Secret key obtained from your Zendesk app.
4. Click Connect with Zendesk to connect.
5. Click Test Connection to verify the connection.

If the test is successful, the Zendesk connection is ready to use in Data Integration.