BizTalk Adapter for Zendesk

Build 20.0.7587

Connecting to Zendesk

Connecting to Zendesk

In addition to completing authentication, set the URL connection property. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

To authenticate to Zendesk, provide Basic authentication or complete the OAuth authentication flow. Use Basic to connect to your own data. Use OAuth to allow other users to connect to their data.

Using Basic Authentication

Zendesk requires your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.
  1. Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
  2. Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

Using OAuth Authentication

OAuth requires the authenticating user to interact with Zendesk using the browser. The adapter facilitates this in various ways as described below.

Register an OAuth Application

Follow the procedure below to register a third-party application and obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret. Note that this procedure requires admin access to your Zendesk account.

  1. In the Zendesk Support Admin interface, go to Admin > Channels > API.
  2. Click the OAuth Clients tab on the Channels/API page and then click the plus icon (+) on the right side of the client list.
  3. Complete the required fields to create a client.

    Set the Redirect URI to http://localhost:33333 or a different port number of your choice. When you connect you will need to set the CallbackURL connection property to this exact URL.

  4. Click Save. After the page refreshes, a new prepopulated Secret field appears on the lower side.
  5. Use the unique identifier as the OAuthClientId and the secret value as the OAuthClientSecret.

Authenticate to Zendesk

After setting the following connection properties, you are ready to connect:

  • OAuthClientId: Set this to the client Id that you specified in your app settings.
  • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
When you connect, the adapter opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The adapter then completes the OAuth process.
  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587