Prerequisites
Complete these steps to create an OAuth application before configuring the connection (OAuth and OAuthPKCE only):1
Log in to your Zendesk account using an account that has admin access.
2
In the Zendesk Support admin interface, navigate to Admin > Channels > API.
3
On the Zendesk API page, click the OAuth Clients tab.
4
At the right side of the client list, click the plus icon (+).
5
Complete the required fields to create a client, then set the Redirect URI to https://oauth.cdata.com/oauth/.
6
Click Save. After the page refreshes, a Secret field appears.
When the Client kind of the OAuth application is set to Confidential, you must use OAuth authentication. When the Client kind of the OAuth application is set to Public, you must use OAuthPKCE authentication.
Setup Guide
Follow these steps to connect Zendesk to your Connect AI account:1
Open the Sources page of the Connect AI navigation menu.
2
Click + Add Connection in the upper-right corner.
3
Type Zendesk into the search field, then click the data source name.
4
On the Basic Settings tab of the new connection, enter a connection name or keep the default name.
5
Enter your Zendesk Support URL.
6
Select the Authentication method, then proceed to the relevant section and follow those instructions.
Authentication Methods
- OAuth
- OAuthPKCE
- APIToken
1
In the OAuth Client Id field, enter the unique identifier from the prerequisites.
2
In the OAuth Client Secret field, enter the secret from the prerequisites.
3
Click Sign in to connect securely through OAuth. This action opens the Zendesk sign-in page in a new tab.
4
Log in to your Zendesk account and provide the requested permissions (if applicable).
5
At the top of the Connect AI Add Connection page, click Save & Test.
- If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
- If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
- Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.