Skip to main content

Initial setup for Zendesk Reader

This section describes how to configure Zendesk and Striim for the Zendesk Reader. You can authenticate using OAuth or username/password credentials. Complete the third-party configuration in Zendesk first, then create a connection profile in Striim.

Third-party (Zendesk) configuration

Enable API access and create an OAuth client

  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, enable the Token Access toggle.

    zd-tokenaccess.png
  4. Open OAuth Clients and click Add OAuth client.

    zendesk-add-oauth-client.png
  5. Enter a client name and a redirect URL, then click Save. Confirm to proceed.

    zndesk-add-oauth-client2.png
  6. Copy the generated OAuth access token and store it securely. It will be hidden once you leave or close the page. Click Save before closing.

    zendesk-add-oauth-client3.png

Notes for OAuth authentication

The following notes may help when completing OAuth setup:

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

  • You can use a test redirect URL (for example, a webhook site URL) or your own redirect URL.

  • To obtain an authorization code, visit the following URL in a browser (replace placeholders):

    https://{subdomain}.zendesk.com/oauth/authorizations/new?response_type=code
    &redirect_uri={your_redirect_url}&client_id={your_client_id}&scope=read write
  • Exchange the authorization code for a bearer token (example using curl):

    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": "read write" }' \
      -X POST

    Sample response:

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

    Common error (example):

    {
      "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

Create a reusable connection profile for Zendesk, then reference it from the Zendesk Reader. You may authenticate via OAuth or username/password.

Create a connection profile (OAuth)

  1. In Striim, navigate to Manage > Connection Profiles and click Add Connection Profile.

  2. Select Endpoint Type as Zendesk and set Host to your subdomain (for example, yourcompany.zendesk.com, without https://).

  3. Click Sign in using OAuth, authenticate with a Zendesk account that has the required permissions, then close the browser window when prompted.

  4. Back in Striim, click Test connection to validate, then Save the profile.

Create a connection profile (username/password)

  1. In Striim, go to Manage > Connection Profiles and click Add Connection Profile.

  2. Select Endpoint Type as Zendesk and set Host (for example, yourcompany.zendesk.com, without https://).

  3. Provide Username (Zendesk user email) and Password.

  4. Click Test connection. If validation succeeds, click Save to store the profile.