Zendesk Support/Talk Query Authentication Guide

Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the Zendesk Support Query and/or Zendesk Talk Query components for use in Matillion ETL.

Creating an OAuth Entry in Matillion ETL

1. In Matillion ETL, on the top left of the screen, click Project → Manage OAuth.

   Please Note

   If a Zendesk Support Query or Zendesk Talk Query component has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:

   1. Click the component icon to open the Properties panel at the bottom of the screen.
   2. Then, click ... next to the Authentication Method input.
   3. Select OAuth from the dropdown menu in the pop-up window and click OK.
   4. The Authentication input will now appear on the list of properties. Click ... next to it, and finally click Manage in the pop-up window.
   

   Project dropdown menu

2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

3. Click + in the bottom left of the window to open the Create OAuth Entry window.

   

   New OAuth entry

4. Click the Service dropdown menu and select Zendesk. Then, provide a name for the OAuth in the Name field and click OK.

   

   Create OAuth Entry window

5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

   Please Note

   This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

   

   New Entry listed on Manage OAuth window

Acquiring Third-Party Credentials

1. Navigate to the Zendesk website and click Sign In on the right above the header.

   

   Zendesk homepage

2. On the next screen, enter the subdomain associated with the account in the field provided and click Sign In. Please make a note of the subdomain, as it will be required later in Authorising for use in Matillion ETL. The browser will then redirect to a login screen. Enter valid login credentials for the account associated with subdomain to continue.

   

   Enter Zendesk account subdomain

3. From the Zendesk dashboard, click ⚙ on the sidebar on the left to open the ADMIN HOME page.

4. Scroll down the menu on the left and click on CHANNELS → API.

5. In the Zendesk API window, click OAuth Clients on the menu at the top.

6. Click the + on the far right, at the top of the All OAuth Clients list.

   

   Zendesk API dashboard

7. In the Create a new OAuth client window, provide details for the following fields:

   • Client Name – provide a name for the app
   • Unique Identifier – provide a client name to be used in code, it will be required later in Authorising for use in Matillion ETL
   • Redirect URLs – paste the Callback URL (copied from the Manage OAuth window in Matillion ETL earlier), then click Save

   

   Create a new OAuth client

8. A prompt will then offer a reminder to Please store the secret that will appear, before refreshing the window. A field entitled Secret will now have appeared under the Redirect URLs field. Copy the code from both the Secret as it will be required in Authorising for use in Matillion ETL.

   Please Note

   • Make sure to copy the Secret right away as it will not appear again after saving or leaving the page.
   • Additionally, when copying the codes, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
   

   Copy the Secret

Authorising for Use in Matillion ETL

1. Return to the Manage OAuth window in Matillion ETL and click ⚙ next to the previously created OAuth entry. This will open the Configure OAuth window.

   

   Configure OAuth settings

2. Using the codes copied from the Zendesk website earlier, provide details for the following fields:

   • Client ID – enter the Unique Identifier
   • Client Secret – enter the Secret
   • URL Prefix – enter the account subdomain, then click Next

   

   Configure OAuth settings

3. The next window will have an Authorization link. Click the link to authorise Matillion ETL to use the acquired credentials.

   

   Authorization link

4. The browser will then redirect to a screen requesting access to the associated Zendesk account. Click Allow to confirm.

   

   Allow access to Zendesk account

5. If all is successful, the browser will return to Matillion ETL with a window stating, "Authorization Successful".

   

   OAuth Authorization successful