Zendesk

Overview

This source connector fetches audit logs events from the Zendesk API.

Streams

Prerequisites

• Confirm that your Zendesk subscription supports viewing audit logs.
• A Zendesk account with an Administrator role
• The unique Zendesk subdomain associated with the account.

Configuration

The following fields are used to configure the source connector:

Authentication

The following authentication methods are supported by this connector:

API token authentication

Generate an API token

Log into Zendesk Admin Center and follow the steps under Generating API tokens to generate the API Token for the connector.

1. Copy the token and save to someplace secure. Once you click save in Zendesk, the full token will never be displayed again.

Configuration

The following fields are specific for the API token authentication method.

OAuth access token authentication

Log into Zendesk Admin Center and follow the steps under Managing OAuth token access to the API.

1. Create an API Token for your user, following the steps above.

   1. This API token is necessary to generate an OAuth token. Once the OAuth token is generated, the API Token can be removed.

2. Create an OAuth Client

   1. Fill out the form accordingly, but note the following:
      1. The Unique identifier will be used in the next step below
      2. Chose the Client kind of Confidential
      3. Add http://localhost as a valid redirect URL

3. Create an OAuth authorization flow

   1. In a browser, navigate to https://{subdomain}.zendesk.com/oauth/authorizations/new?response_type=code&client_id={Unique Identifier}&scope=auditlogs:read to authorize the application.
      1. Replace subdomain and Unique Identifier in the URL first
      2. Once the page has loaded, click "Allow"

4. Find the OAuth client's client_id.

   1. Zendesk does not provide a UI to get this information, but it is available using the browser's developer tools. Open the developer tools and open the Network tab

   2. Navigate away from the OAuth Clients tab, and then navigate back to the OAuth Clients tab. This will initiate the browser to make a new API request for the OAuth Clients list. This request will have a json response, and in there will be the id that is required. This will be used as the client_id in the next step.

      

5. Create the OAuth Access Token

   1. Next, make an API request to Zendesk to generate an OAuth Access Token. This access token does not expire and can be used in the Tarsal configuration below.

   2. Using an administrator's email address and the API Token created in step 1 above, update the subdomain , client_id, email_address and api_token values below, then make the following request:

      curl https://{subdomain}.zendesk.com/api/v2/oauth/tokens.json \
        -X POST \
        -v -u {email_address}/token:{api_token} \
        -H "Content-Type: application/json" \
        -d '{
          "token": {
            "client_id": {client_id},
            "scopes": [
              "auditlogs:read"
            ]
          }
        }'
      

   3. In the JSON response, copy the full_token value. This will be the value to use for the Access Token field in the Tarsal Connector.

      1. The API Token created in step 1 can now be removed.

Configuration

The following fields are specific for the API token authentication method.

Connector Limitations

1. Audit Logs are only available for Enterprise or Enterprise Pro plans.
2. This connector is restricted by rate limits.