What's my plan?
Add-on Quality Assurance (QA) or Workforce Engagement Management (WEM)
Location: Zendesk QA > Settings

This article explains how to set up a custom integration in Zendesk QA. A custom integration allows you to import conversations or users in bulk and export statistical data periodically using the API. Some technical experience may be required.

This article contains the following topics:

  • Setting up a custom integration
  • Obtaining API credentials
  • Finding your workspace ID

Setting up a custom integration

Admins can configure a custom integration in Zendesk QA.

To set up a custom integration

  1. In Quality Assurance, click your profile icon in the top-right corner.
  2. Click Settings ().
  3. In the sidebar () under Account, click Connections.
  4. Click the Add custom integration button in the top.
  5. Enter a name for your new connection.

  6. Select a retention period from the dropdown menu. Inactive conversations for the selected retention period that is, tickets without manual reviews, will be deleted. This deletion includes all ticket review data stored in Zendesk QA. Note that QA data does not affect the data storage limit of your Zendesk account.
  7. Click Add.

Obtaining API credentials

Admins can obtain API credentials in Zendesk QA.

To obtain your API token and account ID

  1. In Quality Assurance, click your profile icon in the top-right corner.
  2. Click Settings ().
  3. In the sidebar () under Account, click Connections.
  4. Click the copy button next to your custom integration (hovering will also reveal the API token).

  5. Click the options menu () next to your connection and select Edit connection.
  6. Copy your account ID. You'll also need this for your API requests.

Finding your workspace ID

To locate your workspace ID

  1. In Zendesk QA, click your profile icon in the bottom-left corner.
  2. Click Users, bots, and workspaces.
  3. Select Workspaces.
  4. Select a workspace and find its ID in the URL.

    For example, in the URL https://zen5-desk-qa.zendesk.com/qa/settings/workspaces/11759/members, the ID is 11759.

With your API token, account ID, and workspace ID, you can now import conversations and export data from Zendesk QA.

Powered by Zendesk