Setting up a custom integration in Zendesk QA



What's my plan?






Add-on


Quality Assurance (QA) or Workforce Engagement Management
(WEM)








Verified AI summary ◀▼


Set up a custom integration to import conversations or users in bulk
and export statistical data using the API. Obtain your API token, account
ID, and workspace ID to start importing and exporting data.





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



In Quality assurance, click your profile icon in the top-right
corner.


Click Settings ( ).


In the sidebar under Account, click
Connections.


Click the Add custom integration
button in the top.


Enter a name for your new connection.





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.


Click Add.





Obtaining API credentials

Admins can obtain API credentials in Zendesk QA.

To obtain your API token and account ID




In Quality assurance, click your profile icon in the top-right
corner.


Click Settings ( ).


In the sidebar under Account, click
Connections.


Click the copy button next to your custom integration (hovering
will also reveal the
API token).





Click the options menu ( )
next to your connection and select
Edit connection.


Copy your account ID. You'll also need this for your API
requests.









Finding your workspace ID


To locate your workspace ID



In Quality assurance, click your profile icon in the top-right
corner, then select Users, bots, and workspaces.


Select Workspaces.


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.




//
const fast_path_style = document.createElement('style');
fast_path_style.innerHTML = `#article-body .fastpath{font-size:.9em;background-color:#f3f3f3;border:1px solid #d3d3d3;padding:10px 10px 8px;margin-bottom:16px}#article-body .fastpath::before{content:none!important}`;
document.head.appendChild(fast_path_style);
//


//
const ai_summary_style = document.createElement('style');
ai_summary_style.innerHTML = `#styled-article-body{padding:0 0 0}#article-body #docs-ai-summary{background-color:#f3f3f3;border:1px solid #d3d3d3;padding:10px 10px 6px;margin-bottom:16px}#article-body #docs-ai-summary #docs-ai-summary-toggle{font-size:.9em;font-weight:700;margin-bottom:4px;cursor:pointer;display:flex;justify-content:space-between;align-items:center}#article-body #docs-ai-summary #docs-ai-summary-toggle #up-triangle{margin-left:auto;padding-right:10px;display:none}#article-body #docs-ai-summary #docs-ai-summary-toggle #down-triangle{margin-left:auto;padding-right:10px}#article-body #docs-ai-summary #docs-ai-summary-content{font-size:.9em;padding-left:25px;padding-right:25px;margin-bottom:12px}`;
document.head.appendChild(ai_summary_style);

const toggleAISummary = () => {
const summary = document.getElementById("docs-ai-summary-content");
const upTriangle = document.getElementById("up-triangle");
const downTriangle = document.getElementById("down-triangle");
if (summary.style.display === "none") {
summary.style.display = "block";
upTriangle.style.display = "none";
downTriangle.style.display = "inline";
} else {
summary.style.display = "none";
upTriangle.style.display = "inline";
downTriangle.style.display = "none";
}
};

document.getElementById("docs-ai-summary-toggle").addEventListener("click", toggleAISummary);
//
