About actions for auto assist and action flows

<body>
<p id="docs-hc-snippet" style="display: none;">Actions are available for use byauto assist, which is part ofthe Copilot add-on, and byaction flows, which perform a pre-defined series of automated actions. There are two types of actions: standard and custom actions.</p>
<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="suite_gpee">
<table>
<tbody>
<tr>
<td>
<strong>All Suites</strong>
</td>
<td>Growth, Professional, Enterprise, or Enterprise Plus</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">Explore actions for auto assist and action flows to streamline customer support tasks. Use standard and custom actions to automate processes, like updating ticket fields or integrating with external systems via APIs. Auto assist suggests actions, which you can approve to save time. Remember, actions don't apply to AI agent tickets. Customize actions to fit your workflow and enhance efficiency.</p>
</div>

<div class="body">

<p class="p"> Actions are available for use by <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/7051314237466" target="_blank">auto assist</a>, which is part of <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/5524125586330" target="_blank">the Copilot add-on</a>, and by <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/8855513857306" target="_blank">action flows</a>, which perform a pre-defined series of
automated actions. There are two types of actions: standard and custom actions.</p>
<p class="p">This article describes what actions are and how they are used in Zendesk.</p>
<div class="p">This article includes the following topics:<ul class="ul" id="topic_sjx_ns2_m2c__ul_xxw_b1h_nhc">
<li class="li"><a class="xref" href="#topic_a12_s5n_xcc">Understanding actions for automated tasks</a></li>
<li class="li"><a class="xref" href="#topic_ubt_qyr_k2c">Understanding standard actions for auto assist</a></li>
<li class="li"><a class="xref" href="#topic_a5n_ryr_k2c">Understanding custom actions</a></li>
</ul>
</div>
<div class="p">Related articles:<ul class="ul" id="topic_sjx_ns2_m2c__ul_zlb_x2s_1fc">
<li class="li"><a class="xref" href="https://support.zendesk.com/hc/en-us/articles/8013439366810" target="_blank">Creating actions for auto assist and action
flows</a></li>
<li class="li"><a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9156980948250" target="_blank">Managing actions for auto assist and action
flows</a></li>
</ul>
</div>
</div>
<div aria-labelledby="ariaid-title2" class="topic nested1" id="topic_a12_s5n_xcc">
<h2 class="title topictitle2" id="ariaid-title2">Understanding actions for automated tasks</h2>
<div class="body">
<div class="note attention" id="topic_a12_s5n_xcc__note_c33_bsh_4cc">
<span class="attentiontitle"></span> You must have the <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/5524125586330" target="_blank">Copilot add-on</a> to use auto assist.</div>
<p class="p">Auto assist suggests relevant actions and action flows to your agents to help them
solve customer requests. When auto assist suggests an action, the agent can approve
it and the system carries out the action automatically, saving the agent time.
Similarly, when auto assist suggests an action flow, the agent can approve it and
the system carries out all of the <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/8855601898266#topic_ybr_z3g_t2c" target="_blank">steps</a> automatically.</p>
<p class="p">Actions and action flows can be linked directly in procedures to ensure that auto
assist performs the correct action for a user's request. Additionally, you can
include custom actions as steps in action flows.</p>
<p class="p">There are two types of actions: <a class="xref" href="#topic_ubt_qyr_k2c">standard actions for auto assist</a> that require no configuration from you
and <a class="xref" href="#topic_a5n_ryr_k2c">custom external actions</a>
that you configure based on an API. </p>
<p class="p">Standard actions don't appear on the Actions page in Admin Center and can't be
modified.</p>
</div>
<div aria-labelledby="ariaid-title3" class="topic nested2" id="topic_uz5_zl1_nhc">
<h3 class="title topictitle3" id="ariaid-title3">Auto assist action limits</h3>
<div class="body">
<p class="p">Auto assist can suggest up to four actions at a time in most cases. Reply
suggestions and agent instructions count towards this limit.</p>
<p class="p">For example, if auto assist suggests a reply, agent instructions, and two
actions, such as updating the ticket status and the ticket priority. In this
case, the action limit will be met.</p>
<p class="p">The exception to this limitation is if auto assist suggests a macro as an action.
When this happens, then the suggestion can include only agent instructions in
addition to the macro. Auto assist can't suggest a macro and any other type of
action at the same time. </p>
<p class="p">Keep these limitations in mind when <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/7924047699738#topic_vs3_j44_xcc" target="_blank">writing procedures</a>, especially when
including steps that combine multiple actions.</p>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title4" class="topic nested1" id="topic_ubt_qyr_k2c">
<h2 class="title topictitle2" id="ariaid-title4">Understanding standard actions for auto assist</h2>
<div class="body">
<p class="p">Auto assist includes the following standard actions:</p>
<ul class="ul" id="topic_ubt_qyr_k2c__ul_wgr_kk4_xcc">
<li class="li">Update ticket status to any standard or custom status</li>
<li class="li">Update the priority, type, and tags ticket fields</li>
<li class="li">Update checkbox, date, decimal, dropdown, number, or regex custom ticket
fields</li>
<li class="li">Leverage a Shopify integration to look up a Shopify order, cancel and refund an
entire Shopify order, or refund selected items from a Shopify order. (See <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/7719560079642" target="_blank">Workflow recipe: Canceling and refunding a
Shopify order with auto assist</a>.)</li>
</ul>
<p class="p">You can also update the ticket assignee and group, but these capabilities don't
appear in the standard actions list. To update the ticket assignee or group in a
procedure, enter an instruction such as, "Set the ticket assignee to [Agent name]"
or "Change the ticket group to [Group Name]." Auto assist recognizes the instruction
and applies its built-in logic automatically when the step is triggered.</p>
<p class="p">When you insert a standard action in a procedure, you must specify the value you want
auto assist to update the ticket or field to. The reference to value is entered
directly after the standard action in the procedure.</p>
<p class="p"><img class="image img-screenshot" id="topic_ubt_qyr_k2c__image_avr_hzj_hgc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/copilot_procedure_action_add_value.png" width="600"></p>
<p class="p">You can reference the value by entering it in plain text or by using a value from the
conversation, another field, or another action. </p>
<div class="p">For example, say you insert the action <code class="ph codeph">Change field 'Language'</code>. You
could enter any of the following to specify a value:<ul class="ul" id="topic_ubt_qyr_k2c__ul_ams_xyj_hgc">
<li class="li">
<code class="ph codeph">Change field 'Language'</code> to Spanish</li>
<li class="li">
<code class="ph codeph">Change field 'Language'</code> to the value from "Product
language" field</li>
<li class="li">
<code class="ph codeph">Change field 'Language'</code> to the language used by the
customer</li>
<li class="li">
<code class="ph codeph">Change field 'Language'</code> to language returned by Action or
Action flow</li>
</ul>
</div>
<p class="p">If you insert a standard action in a procedure that updates a <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4408834799770#topic_ydk_2b1_phb" target="_blank">conditional ticket field</a>, then you must
position the action to update the conditional field before the action that updates
its parent ticket field. This is because actions are executed sequentially and
required fields must be set first for the subsequent actions to succeed.</p>
<p class="p">For example, if the parent field in a conditional ticket field is named "Product" and
is configured to display the conditional field "Model" when the value "Laptop" is
selected. In this case, you should position the action to update the "Model" field
before the action to update the "Product" field. </p>
<p class="p"><img class="image img-screenshot" id="topic_ubt_qyr_k2c__image_opr_fwy_c3c" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/ai_ctf_action_position_procedure.png" width="600"></p>
</div>
</div>
<div aria-labelledby="ariaid-title5" class="topic nested1" id="topic_a5n_ryr_k2c">
<h2 class="title topictitle2" id="ariaid-title5">Understanding custom actions</h2>
<div class="body">
<p class="p">Custom actions allow you to update data outside of Zendesk using an API you define.
These actions allow you to query and modify your internal business systems or
perform a third-party action. The more actions you configure, the more options are
available to auto assist when it generates suggestions for agents.</p>
</div>
<div aria-labelledby="ariaid-title6" class="topic nested2" id="topic_fkn_3zr_k2c">
<h3 class="title topictitle3" id="ariaid-title6">Using Zendesk APIs with custom actions</h3>
<div class="body">
<p class="p">Because you can create custom external actions using any API, it's possible to
create an external action that points to a <a class="xref" href="https://developer.zendesk.com/api-reference/" target="_blank">Zendesk API</a>. If you do this, however, there are some
considerations to keep in mind: </p>
<ul class="ul" id="topic_fkn_3zr_k2c__ul_rx2_rh4_xcc">
<li class="li">These API requests count against your overall Zendesk API rate limits. See
<a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4408836402074" target="_blank">Managing API usage in your Zendesk
account</a>. </li>
<li class="li">Custom actions support bursts of up to 280 action executions, and can then
continue at a rate of 6 executions per second during a recharge period. This
limit applies to custom action executions in action flows and auto assist
cumulatively.</li>
<li class="li">As part of action setup, you’ll <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/5040378297626" target="_blank">create a connection</a> to authorize
the request, which uses a Zendesk API token or OAuth token. This connection
might have greater access privileges than your agents and end users, so
you’ll need to be cautious that you don’t accidentally expose information
they shouldn’t see.</li>
<li class="li">In the future, you’ll need to migrate your Zendesk API actions to
out-of-the-box Zendesk actions if and when equivalent actions become
available.</li>
<li class="li">Be mindful of how changes made by these API requests may interact with other
parts of your Zendesk configuration, such as triggers, automations, and
apps.</li>
</ul>
</div>
</div>
<div aria-labelledby="ariaid-title7" class="topic nested2" id="topic_n3p_gzr_k2c">
<h3 class="title topictitle3" id="ariaid-title7">About inputs for custom actions</h3>
<div class="body">
<p class="p">An input for a custom action is the information that the action uses in order to
run. </p>
<div class="p">You can create inputs for actions that reference the following types of
information:<ul class="ul" id="topic_n3p_gzr_k2c__ul_ypz_1jq_cfc">
<li class="li">
<strong class="ph b">Generated information, based on the conversation between the end user
and the agent</strong><p class="p">Auto assist uses generative AI to extract
information from the conversation and passes it to an action or
action flow as an input.</p>
<p class="p">For example, say you have an input
named "order_id" with the description “the customer’s order number,
which is typically an integer of 9 or 10 digits”. If an agent asks,
"Can I please have your order number?" and the end user replies,
"Sure, it's 987654321", the action will pass this information to the
"order_id" input.</p>
</li>
<li class="li">
<strong class="ph b">Ticket fields</strong><p class="p">Custom ticket fields, and <a class="xref" href="#topic_n3p_gzr_k2c__ul_hgw_czr_k2c">certain
standard ticket fields listed below</a>, can be used as
inputs. When using a ticket field as an input, enter a name and
description that's detailed enough that auto assist understands
which ticket field you're specifying.</p>
<p class="p">For example, entering
"email" as an input isn't clear enough. Instead, you may want to
name an input "requester_email" with a description such as "the
email address of the end user who requested help."</p>
</li>
<li class="li">
<strong class="ph b">Ticket ID</strong><p class="p">When using the ticket ID as an input, you must use
the specific name <em class="ph i">zendesk_ticket_id</em> and set the type as a
number. Auto assist populates that input with the ID of the
ticket.</p>
<p class="p">When making use of the input in your API
configuration, you can wrap the input placeholder in quotes to
convert it to a string, or incorporate it into a larger string.
</p>
<p class="p">For example, you could have the following property in your
API body:</p>
<div class="p">
<pre class="pre">"note":"Ticket number {{zendesk_ticket_id}} has been updated!"</pre>
</div>
</li>
</ul>
</div>
<p class="p">Auto assist has access to read custom ticket fields and the standard ticket
fields below:</p>
<ul class="ul" id="topic_n3p_gzr_k2c__ul_hgw_czr_k2c">
<li class="li">Assignee email </li>
<li class="li">Assignee name</li>
<li class="li">Brand </li>
<li class="li">Custom ticket fields</li>
<li class="li">Priority </li>
<li class="li">Requester email </li>
<li class="li">Requester name </li>
<li class="li">Status </li>
<li class="li">Subject</li>
<li class="li">Type </li>
</ul>
<div class="p">
<div class="note note" id="topic_n3p_gzr_k2c__note_cmc_wg5_wgc">
<span class="notetitle">Note:</span> Actions don’t work on <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9204149016346" target="_blank">AI agent tickets</a>.</div>
</div>
</div>
</div>
</div>
<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>
</body>