> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk

export const title_2 = "Zendesk";

export const title_1 = "Zendesk";

export const title_0 = "Zendesk";

## Prerequisites

Complete these steps to create an OAuth application before configuring the connection (OAuth and OAuthPKCE only):

<Steps>
  <Step>
    Log in to your Zendesk account using an account that has admin access.
  </Step>

  <Step>
    In the Zendesk Support admin interface, navigate to **Admin > Channels > API**.
  </Step>

  <Step>
    On the **Zendesk API** page, click the **OAuth Clients** tab.
  </Step>

  <Step>
    At the right side of the client list, click the plus icon (**+**).
  </Step>

  <Step>
    Complete the required fields to create a client, then set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Save**. After the page refreshes, a **Secret** field appears.
    <Note>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.</Note>
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zendesk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zendesk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Zendesk Support **URL**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        In the **OAuth Client Id** field, enter the unique identifier from the prerequisites.
      </Step>

      <Step>
        In the **OAuth Client Secret** field, enter the secret from the prerequisites.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Zendesk sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Zendesk account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} 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.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth with PKCE. This action opens the Zendesk sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Zendesk account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} 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.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        In the **User** field, enter the Zendesk username for authentication.
      </Step>

      <Step>
        In the Zendesk Support admin interface, navigate to **Admin > Channels > API** and create an API token on the **Zendesk API** page.
      </Step>

      <Step>
        In the **API Token** field, enter the API token.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_2} 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.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Zendesk, see [this information page](https://cdn.cdata.com/help/FZK/cloud/default.htm#default).