Product DocsMenu

Coveo Platform 7.0 >
Administrator Help > Connectors > Zendesk Connector > Authorizing Access to the Zendesk Content Using an Admin Account

Authorizing the Coveo Connector to Access Your Zendesk Content

You can grant the Coveo connector access to your Zendesk customer service website content using a Zendesk API v2 token. It is however recommended to perform the complete OAuth 2.0 protocol for security reasons (can grant the access to your Zendesk content with only read permission).

The OAuth 2.0 protocol is a protocol used for granting access to external applications without exposing the user's real credentials. For the connector to be able to connect to the content of your Zendesk customer service website, it must acquire an access token.

To authorize the Coveo connector to access your Zendesk content

  1. Log into your Zendesk customer service website with an administrator account.

  2. Access the agent interface, by clicking the drop-down list menu in the top right of the page, and then selecting Open agent interface.

  3. In the agent interface, access the Zendesk API page:

    1. In the navigation bar on the left, click the Admin icon .

    2. In the admin setting menu, under Channels, click API.

  4. In the Zendesk API page, depending on the way you want to grant access to your Zendesk content:

    • Using OAuth 2.0

      1. Click the OAuth Clients tab.

      2. In the OAuth Clients tab, click add a client.

      3. In the New OAuth Client page:

        1. In the Client Name box, enter a descriptive application name.

          Example: Coveo Connector

        2. Take note of the Unique Identifier auto-populated. You need this value during the OAuth authentication process.

        3. In the Redirect URLs box, enter http://localhost/.

        4. Click Save.

        5. Take note of your application Secret.

        6. Click Save again.

      4. Authorize your application to use your Zendesk administrator account:

        1. Open another browser tab by pressing CTRL+t.

        2. In the new tab, copy and paste the following URL in the browser address bar after entering your website and client ID at the specified places: https://[YOUR_WEBSITE][YOUR_UNIQUE_IDENTIFIER]&scope=read.

        3. In the Allow [ClientName] to access your Zendesk account screen, click Allow to receive an authorization code from Zendesk.

          You are redirected to the URI you specified when configuring the Zendesk app.

        4. In your browser address bar, take note of the access token returned by the Zendesk API. You need this value when configuring your Zendesk source (see Configuring and Indexing a Zendesk Source).

          Example: http://localhost/#access_token=[ACCESS_TOKEN]&scope=read&token_type=bearer

    • Using a Zendesk API v2 token:

      1. In the Zendesk API page, in the Settings tab, next to Token Access, select the Enabled check box.

      2. In the section that appears, click add new token.

      3. In the Enter a label for this API Token dialog that appears, enter a descriptive name, and then click Create.

        Example: CoveoConnector

      4. Back in the API page, next to Token Access, select the Enabled check box.

      5. Under Active API tokens, take note of the API token. You need this value when configuring your Zendesk source (see Configuring and Indexing a Zendesk Source).

      6. Click Save.

What's Next?

Create a Zendesk source (Configuring and Indexing a Zendesk Source).

People who viewed this topic also viewed