Setting up a custom integration in Zendesk QA

<div class="article-banners">
<div id="docs-wmp-link">
<a href="https://support.zendesk.com/hc/en-us/articles/5411234991258-plan" rel="noopener" target="_blank">What's my plan?</a>
</div>
<div class="article-banner" id="addon_zqa">
<table style="margin-left: 0px; margin-right: auto;">
<tbody>
<tr>
<td>
<strong>Add-on</strong>
</td>
<td>
Quality Assurance (QA) or Workforce Engagement Management
(WEM)
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="docs-ai-summary">
<p id="docs-ai-summary-toggle">
Verified AI summary <span id="up-triangle">◀</span><span id="down-triangle">▼</span>
</p>
<p id="docs-ai-summary-content">
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.
</p>
</div>
<div class="body">
<div class="p">
<div class="note fastpath">
<span class="fastpathtitle">Location: </span> Zendesk QA &gt; Settings
</div>
</div>
<p class="p" dir="ltr">
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.
</p>
<p class="p" dir="ltr">This article contains the following topics:</p>
<ul class="ul" id="topic-1__ul_n5h_kqh_vdc">
<li class="li" dir="ltr">
<a class="xref" href="#topic_ljg_4qh_vdc">Setting up a custom
integration</a>
</li>
<li class="li" dir="ltr">
<a class="xref" href="#about_custom_integration">Obtaining API
credentials</a>
</li>
<li class="li" dir="ltr">
<a class="xref" href="#finding_workspace_id">Finding your workspace
ID</a>
</li>
</ul>
</div>
<div aria-labelledby="ariaid-title2" class="topic nested1" id="topic_ljg_4qh_vdc">
<h2 class="title topictitle2" id="ariaid-title2">Setting up a custom integration</h2>
<div class="body">
<p class="p" dir="ltr">Admins can configure a custom integration in Zendesk QA.</p>
<p class="p" dir="ltr">
<strong class="ph b">To set up a custom integration</strong>
</p>
<ol class="ol" id="topic_ljg_4qh_vdc__ol_lkd_1yg_vdc">
<li class="li" dir="ltr">
<span class="ph">In <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4408838272410" target="_blank">Quality assurance</a>, click your profile icon in the top-right
corner.</span>
</li>
<li class="li" dir="ltr">
<span class="ph">Click <strong class="ph b">Settings</strong> (<img class="image" height="17" id="topic_ljg_4qh_vdc__d8e133" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/zqa_settings.png" width="20">).</span>
</li>
<li class="li" dir="ltr">
<span class="ph">In the sidebar under <strong class="ph b">Account</strong>, click
<strong class="ph b">Connections</strong>.</span>
</li>
<li class="li">
Click the <strong class="ph b">Add custom integration</strong>
button in the top.
</li>
<li class="li" dir="ltr">
Enter a name for your new connection.
<p class="p">
<img class="image" id="topic_ljg_4qh_vdc__image_kdk_rrh_vdc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/zqa_7043669282714_1.png" width="400">
</p>
</li>
<li class="li" dir="ltr">
Select a retention period from the dropdown menu. Inactive conversations
for
the selected retention period that is, tickets without
<a class="xref" href="https://support.zendesk.com/hc/en-us/articles/7043669307418#topic_ows_lv2_p2c" target="_blank">manual reviews</a>,
will be deleted. This deletion
includes all ticket review data stored in Zendesk QA. Note that
QA data does not affect
the
<a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4408835043994" target="_blank">data storage limit</a>
of your Zendesk account.
</li>
<li class="li" dir="ltr">
Click <strong class="ph b">Add</strong>.
</li>
</ol>
</div>
</div>
<div aria-labelledby="ariaid-title3" class="topic nested1" id="about_custom_integration">
<h2 class="title topictitle2" id="ariaid-title3">Obtaining API credentials</h2>
<div class="body">
<p class="p" dir="ltr">Admins can obtain API credentials in Zendesk QA.</p>
<p class="p" dir="ltr">
<strong class="ph b">To obtain your API token and account ID</strong>
</p>
<div class="p">
<ol class="ol" id="about_custom_integration__ol_f2s_csh_vdc">
<li class="li" dir="ltr">
<span class="ph">In <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4408838272410" target="_blank">Quality assurance</a>, click your profile icon in the top-right
corner.</span>
</li>
<li class="li" dir="ltr">
<span class="ph">Click <strong class="ph b">Settings</strong> (<img class="image" height="17" id="about_custom_integration__d8e133" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/zqa_settings.png" width="20">).</span>
</li>
<li class="li" dir="ltr">
<span class="ph">In the sidebar under <strong class="ph b">Account</strong>, click
<strong class="ph b">Connections</strong>.</span>
</li>
<li class="li">
Click the copy button next to your custom integration (hovering
will also reveal the
API token).
<p class="p">
<img class="image" id="about_custom_integration__image_qtm_gsh_vdc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/zqa_7043669282714_2.png" width="600">
</p>
</li>
<li class="li">
Click the options menu (<img class="image" height="23" id="about_custom_integration__image_bly_4rt_5dc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/sell_icon_menu_horizontal.png" width="23">)
next to your connection and select<strong class="ph b">
Edit connection</strong>.
</li>
<li class="li">
Copy your account ID. You'll also need this for your API
requests.
<p class="p">
<img class="image" id="about_custom_integration__image_v3m_4sh_vdc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/zqa_7043669282714_3.png" width="600">
</p>
</li>
</ol>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title4" class="topic nested1" id="finding_workspace_id">
<h2 class="title topictitle2" id="ariaid-title4">Finding your workspace ID</h2>
<div class="body">
<p class="p">
<strong class="ph b">To locate your workspace ID</strong>
</p>
<ol class="ol">
<li class="li">
<span class="ph">In <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4408838272410" target="_blank">Quality assurance</a>, click your profile icon in the top-right
corner, then select <strong class="ph b">Users, bots, and workspaces</strong>.</span>
</li>
<li class="li">
Select <strong class="ph b">Workspaces</strong>.
</li>
<li class="li">
Select a workspace and find its ID in the URL.
<p class="p">
For example, in the URL
<code class="ph codeph">https://zen5-desk-qa.zendesk.com/qa/settings/workspaces/11759/members</code>,
the ID is <code class="ph codeph">11759</code>.
</p>
</li>
</ol>
<p class="p">
With your API token, account ID, and workspace ID, you can now
<a class="xref" href="https://support.zendesk.com/hc/en-us/articles/7043724785178" target="_blank">import conversations</a>
and
<a class="xref" href="https://support.zendesk.com/hc/en-us/articles/7043724806810" target="_blank">export data</a>
from Zendesk QA.
</p>
</div>
</div>
<script id="fast-path-script">
//<![CDATA[
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);
//]]>
</script>
<script id="ai-summary-script">
//<![CDATA[
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);
//]]>
</script>