Skip to content

Zendesk Connector

You can easily configure SearchAI to connect to the Zendesk application to enable users to fetch query results using the content in Zendesk Knowledge Base articles.

Specifications

Type of Repository Cloud
Supported API version REST API v2
Answers Support Zendesk knowledge base articles

Authorization Support

Search AI supports OAuth 2.0 Authorization Code Grant Type mechanism for Zendesk. To configure Zendesk as a content source, it requires:

  • Adding an OAuth client in Zendesk
  • Configuring the Zendesk connector in Search AI

Step 1: Setup an OAuth client in Zendesk

The first step is to set up an OAuth client in Zendesk and generate OAuth credentials that SearchAI can use to authenticate the requests sent to Zendesk.

  1. Go to the Admin Center in your Zendesk application. Admin Center

  2. Register Search AI as OAuth Client. Refer to this documentation for information about the fields required in the configuration. Set the Redirect URLs field to point to one of the following callback URLs as per your region.

On saving the details, a pre-populated Secret field appears on the page. This is the client secret required for configuration in SearchAI along with the Unique Identifier generated while registering the application.

Step 2: Configure the Zendesk connector in SearchAI

Go to the Connectors**under the Sources page and select **Zendesk. Go to the Authorization tab, enter the following details, and click Connect.

  • Name: Unique name for the connector.
  • Authorization Type: Search AI supports only OAuth 2.0 authorization with Zendesk.
  • Grant Type: Method of obtaining access token in OAuth 2.0 authentication. SearchAI supports the Authorization Code grant type for Zendesk Refer to this for more information on Grant types.
  • Client ID: The client ID generated after registering SearchAI for OAuth authentication.
  • Client Secret: The secret generated while configuring the OAuth authentication.
  • Host URL: URL pointing to your Zendesk instance.

After a successful connection, the content can be ingested from Zendesk using the Sync Now option under the Configuration tab.