Enable Authentication in Zendesk

For Basic Authentication:

Enable password or token access in the Zendesk API admin configuration.

For OAuth 2.0 Authentication:

  • Enable Password Access in the Zendesk API admin configuration.

  • Create a new OAuth client by providing the Client Name in the Zendesk API admin configuration.

  • Use the same Client Name for the Client ID and generated Client Secret on your Zendesk application.

Important
Client Secret is only visible in the Zendesk managed system during the creation of the OAuth client.

For the most up-to-date information about performing tasks in Zendesk, refer to the Zendesk documentation.

  1. In Zendesk Support, select Admin > Channels > API.

  2. In the Settings tab, enable Password Access or Token Access

  1. In Zendesk Support, select Admin > Channels > API, then select the OAuth clients tab.

  2. Click the plus icon (+) on the right side of the client list.

  3. Complete the following fields to create a client:

    Enter a name for your app. This is the name that users will see when asked to grant access to your application, and when they check the list of third-party apps that have access to their Zendesk.

    Optional. This is a short description of your app that users will see when asked to grant access to it.

    Optional. This is the company name that users will see when asked to grant access to your application. The information can help them understand who they're granting access to.

    Optional. This is the logo that users will see when asked to grant access to your application. The image can be a JPG, GIF, or PNG. For best results, upload a square image. It will be resized for the authorization page.

    The field is auto-populated with a reformatted version of the name you entered for your app. You can change it if you want.

    Enter the URL or URLs that Zendesk should use to send the user's decision to grant access to your application. The URLs must be absolute and not relative, https (unless localhost or 127.0.0.1), and newline-separated.

  4. Click Save.

    After the page refreshes, a new pre-populated Secret field appears on the lower side. This is the client_secret value specified in the OAuth2 spec.

  5. Copy the Secret value to your clipboard and save it somewhere safe. Note: The characters may extend past the width of the text box, so make sure to select everything before copying.

    Important
    For security reasons, your secret is displayed fully only once. After clicking Save, you'll only have access to the first nine characters.

  6. Click Save.

Use the unique identifier and the secret value in the Connectivity and Authentication section.