Skip to main content

Zendesk Reader initial setup

The Zendesk Reader for Striim can authenticate using OAuth or with username and password credentials.

Generating an OAuth client and access token for the Zendesk Reader

Wizards require an OAuth client andAPI token when you configure the Zendesk Reader to use API token authentication.

  1. Log in to the Zendesk Admin Center.

  2. Navigate to Apps and Integrations > APIs > Zendesk API.

    zd-apps-n-integrations.png
  3. In Settings, confirm that the Token Access toggle is enabled.

    zd-tokenaccess.png
  4. Navigate to Oauth Clients to create a new Oauth client.

  5. Click Add Oauth client.

    zendesk-add-oauth-client.png
  6. Enter a client name, redirect URL, and click Save. Click OK to proceed.

    zndesk-add-oauth-client2.png
  7. The token generated below is the OAuth access token used for OAuth flow. Make sure to copy it as it will be hidden once you leave/close the page. Click Save before closing the page.

    zendesk-add-oauth-client3.png

Notes about OAuth authentication

The following are notes about OAuth authentication:

  • If you did not save the token, you can regenerate a new one.

  • Visit the webhook site to get a re-direct URL (for example: https://webhook.site/ab28cb72-c534-4082-9e26-e4ed41c680b5) or enter your own redirect URL.

  • Generate code, by visiting https://{subdomain}.zendesk.com/oauth/authorizations/new?response_type=code&redirect_uri={your_redirect_url}&client_id={your_unique_identifier}&scope=read write

    For example : https://striim1234567890.zendesk.com/oauth/authorizations/new?response_type=code&redirect_uri=https://webhook.site/ab28cb72-c534-4082-9e26-e4ed41c680b5&client_id=app_adapter&scope=read write

  • Execute the below curl to generate the OAuth bearer token:

    curl https://{subdomain}.zendesk.com/oauth/tokens \
      -H "Content-Type: application/json" \
      -d '{"grant_type": "authorization_code", "code": "{your_code}",
        "client_id": "{your_client_id}", "client_secret": "{your_client_secret}", 
        "redirect_uri": "{your_redirect_url}", "scope": "tickets:write read" }' \
      -X POST

    Sample response:

    {
        "access_token": "8f782c9720c74866d2bcxxxxxxxxxxxxx",
        "token_type": "bearer",
        "scope": "read write"
    }

    Common issues:

    {
        "error": "invalid_grant",
        "error_description": "The provided access grant is invalid, expired, or revoked (e.g. invalid assertion, expired authorization token, bad end-user password credentials, or mismatching authorization code and redirection URI)."
    }

Configuring a connection profile in Striim for Zendesk

You can configure the connection profile in Striim for Zendesk Reader for authentication using OAuth or with username and password credentials.

Setting Zendesk OAuth properties

You can specify the following connection properties:

  • Host: specify a Zendesk connection URL, such as subdomain.zendesk.com (do not include https://).

After specifying the host, click Sign in using OAuth. Log in with a Zendesk account that has required permissions. Once you log in successfully, close the browser window, return to the connection profile page, and test the connection.

Setting Zendesk credential properties

You can specify the following connection properties:

  • Host: specify a Zendesk connection URL, such as subdomain.zendesk.com (do not include https://).

  • Username: specify the user email address of your Zendesk instance.

  • Password: specify the password of your Zendesk instance.

After specifying these values click on Test connection to check If the provided values are valid, then proceed to save them.