Zendesk Agent Scripting App – Version 12

If you’re a Zendesk user in a Contact Center environment,  you’ll want to be using our Zendesk Agent Scripting app. This makes it easy to guide, train and onboard agents and is a huge productivity booster for everyone.

Contents of this Article

Overview: Sidebar and Popover views
Pause and Resume
Benefits of the Zendesk Agent Scripting App
New Features in Version 12
Demo Video
Getting Started
Installing the Agent Scripting App into Zendesk
Configuring the App
Enabling Automatic Script Selection
How to Configure to Update Ticket Fields
Using Zingtree Data Entry Fields to Update Tickets
Using Zingtree’s Zendesk CSS Theme
Try It with Example Data

Overview: Sidebar and Popover views

Version 12 gives you the option to show your script directly in the right-hand panel when viewing a ticket, like this:

Or you can use less sidebar space, and make it appear as a button in the right-hand panel:

Click Open Script, and you’ll see your decision tree in a larger pop-over like this:

Pause and Resume

This happens automatically: If another agent picks up a ticket, they return to the last viewed node, and can see each step taken previously by opening the History.

Benefits of the Zendesk Agent Scripting App

• Standardization: Show a guided path for each ticket, so that Agents follow the proper operating policies or troubleshooting procedures.
• Pause and Resume: If a ticket is transferred, the supervisor or new agent is taken to the last place in the script, and can see the history of the previous steps taken.
• Automatic Script Selection: The Agent Scripting App can choose a script based on the Zendesk brand, Zendesk ticket tags, or the value of a custom field.
• Agent Feedback: Agents can send feedback directly to the authors of the decision trees with a single button click. Feedback is delivered to each author’s email, and includes the tree ID and node number where the feedback was sent from.
• Zendesk Ticket Data in your Scripts: Values in any custom field, the agent name, customer info, as well as Zendesk ticket tags and user tags, are transferred into your script so you can display them, or use these variables to branch via Logic Nodes.
• Automatic Ticket Updating: Tags and custom fields in the ticket can be updated from actions in the script – either via buttons clicked in the script, or from data entry collected.

New Features in Version 12

If  you’re using version 11 of the Zendesk Agent Scripting app, you may want to upgrade to take advantages of these new benefits:

• Option to choose between Sidebar and Popover views
• New customer information data variables sent from Zendesk: requester_name and requester_email
• New Zendesk Theme to match Zendesk fonts and styling. This gives you a little more real estate for your content, especially in side-panel mode.

If you’re upgrading from version 10, these features are also new:

• Toggle to share Zendesk data with Zingtree: Some customers don’t want ticket data shared with Zingtree. There’s now an option to disable data sharing.
• Removed “Flash”: Some customers experienced a “flash” when moving from ticket to ticket in pop-over mode. This is now fixed with this update.

Demo Video

This two-minute video shows you how Agents interact with the Agent Scripting App:

Getting Started

Here are the basic steps to get up and running:

1. Build an interactive decision tree script with Zingtree (or use one of our demos to start).
2. Install the Agent Scripting App (version 12) into Zendesk.
3. Configure the Agent Scripting app within Zendesk.
4. If you want to have your decision tree scripts update your  Zendesk tickets, you’ll need to add variables and/or tags to your Zingtree tree to match your Zendesk setup.
5. If you want to enable automatic script selection, you’ll need to add tags to your trees in Zingtree and configure the Zendesk Agent Scripting app properly.

Installing the Agent Scripting App into Zendesk

Download and configure the Zendesk Agent Scripting App version 12 like so:

1. Download the Agent Scripting app Version 12 here.
2. In Zendesk, click the Admin icon and go to Apps > Manage.

3. Click Upload Private App.

4. The Upload App page appears.

5. Enter “Zingtree Agent Scripting” for the App Name.
6. For App File, locate the file zingtree-agent-scripting.zip you downloaded in step 1.
7. Click Upload, then confirm if necessary.

Configuring the App

Once you’ve uploaded the app, click App Configuration to see the configuration screen:

Here’s what each item does:

Tree ID: This is the default tree that appears when agents click “Open Script”.  (You should always have a default tree.)

Show Tree in Side Panel: Select this option if you want to display the entire tree in the right-hand sidebar when a ticket is open. Uncheck this to use pop-over mode instead.

Hide Integration Setup Info: When you are setting up Agent Scripting for the first time, you may need some information about your Zendesk setup to take advantage of automatically updating ticket fields. An “Integration Setup Info” link appears by default when you first install the app, and ticking this option hides it.

Match Tree Tags to Zendesk Brand: If this option is checked, the subdomain of the selected brand will be matched to a Zingtree tree tag.  Any matching tree or trees will appear.  For example, if the brand subdomain is xyz.zendesk.com, any trees tagged as xyz (using the Zingtree Settings tool) will appear.

Match Tree Tags to Zendesk Ticket Tags: If checked, the values in the Zendesk ticket tags will be matched with your Zingtree tree tags (set via the Zingtree Settings tool) to show one or more matching scripts.

Match Tree Tags to values in a Custom field: If you want to use a custom field value to show matching scripts, enter the Zendesk custom field identifier here. The field name can be found using the Integration Setup Info link that first appears in the sidebar when you install the app.

Display Half-Height: In Popover mode, the popup view will cover half the height of the screen. This has no effect when using Sidebar mode.

Don’t share Zendesk Custom Fields with Zingtree: By default, the app sends custom field data from each Zendesk ticket to Zingtree so you can do more powerful automatic branching via logic nodes, as well as echoing customer information (like their name, for example). If your organization has data privacy concerns, you can check this option to disable data sharing.

Zingtree API key: Each organization in Zingtree has an API key, which is used to match scripts. If you’re using one of the tag matching options, this is required. Your API key can be found at zingtree.com under Resources, API.

Data Sent from Zendesk to Zingtree

Unless you select the Don’t share Zendesk Custom Fields with Zingtree configuration option, Zendesk will send the following variables to your Zingtree decision tree:

• requester_name – The customer’s full name.
• requester_email – The email of the customer.
• zendesk_tags – Any tags in the ticket.
• agent_tags – Any tags from the agent.
• agent – The Agent’s full name.
• agent_first_name – The Agent’s first name.
• Any custom fields

To display one of these values, just surround the variable name with # characters. So to show the Agent’s first name in your script, enter #agent_first_name# in the content area of any node in your decision tree.

Tip: Add #ALL DATA# to the content area of any node in your own tree to see all the variables sent to your script.

Enabling Automatic Script Selection

Automatic Script Selection works by matching tree tags you set in Zingtree to values in the Brand, Tags, or a custom field in a Zendesk ticket. For example, if a tree is tagged with “astrology”, and the ticket tags include “astrology”, then that tree appears. If several trees match, then they will all appear, and the agent can choose one.

To open a script based on Brand:

• Add tags to your trees for each brand you want to match. So if one of your brands is xyz.zendesk.com, use xyz as a tree tag in Zingtree for all the trees you want to show.
• Make sure Match Tree Tags to Zendesk Brand is checked in the App Configuration.

To open a script based upon Zendesk ticket tags:

• Add tags to your trees for each tag you want to match. So if one of your ticket tag possibilities is “billing”, use billing as a tree tag in Zingtree for all the trees you want to show.
• Make sure Match Tree Tags to Zendesk Ticket Tags is checked in the App Configuration.

To open a script based upon a custom field:

• Add tags to your trees for each possible custom field value you want to match. So if one of your custom field values is “billing”, use billing as a tree tag in Zingtree for all the trees you want to show.
• Make sure the proper Zendesk field variable name is entered for  Match Tree Tags to values in a Custom Field in the App Configuration.

Adding tags to a tree in Zingtree is done like this:

1. Select a tree from My Trees.
2. Go to the Settings tool.
3. Click the Tags tab.
4. Enter or select a tag from the Tree Tags field.

5. Click Update All Settings.

How to Configure to Update Ticket Fields

As agents navigate through your trees, their use of the decision tree scripts you create can automatically update any custom fields in that ticket. This can be done in two ways:

• By clicking a button in a script
• By entering data into Zingtree data entry fields.

The key is to use variable names in your Zingtree that match the ones used in Zendesk.

First of all, determine the names of the variables in Zendesk by clicking the Integration Setup Info link in the Agent Scripting app. You’ll see something like this:

You’ll see the label for the field as it appears in Zendesk’s ticket form and the Zendesk variable next to it. In the above example, the Product custom field variable is custom_field_22899289. This is a drop-down selector, and the Zendesk values for the field options are astrology and insurance.

For the rest of this example, we’ll use custom_field_22899289 as the custom field variable.

To make a button selection update a custom field, you’ll set it up in your Zingtree as follows:

1. Go to the Overview tool, and edit the node whose button selections will update the ticket.
2. Click Edit Buttons (or Add Buttons if you don’t have any buttons defined). The button editor appears:

3. Make sure Assign Button Click Variable is checked. This makes the other options appear.
4. For the Button Click Variable, enter your custom field variable from Zendesk (custom_field_22899289 in the example).
5. For each button option, enter the value of the variable under Score/Value. If this is a drop-down list in your Zendesk ticket, you’ll need to make sure the Score/Value entered matches one of the drop-down option values as shown in the Integration Setup Info.
6. Click Save Changes when you’re done configuring buttons.

Bonus: Adding Tags via button clicks:

Button clicks can also add tags to a ticket. In the above example, clicking Something Else adds the tag other_tag to the ticket. Just include the tag name with two colons after the button text. So entering a button like Something Else::other_tag will add the tag other_tag to the ticket if this is clicked, but agents will only see Something Else as an option.

Using Zingtree Data Entry Fields to Update Tickets

Just like the above example, you can also use Zingtree for data entry and have that data automatically transferred to your ticket. The key is to use the same variable name in Zingtree as you used in Zendesk. The Integration Setup Info link in the sidebar will give you those Zendesk variable names.

Example: If you have a text entry field in Zingtree you want to update into the Zendesk field custom_field_1234, you would set up the variable name as follows:

Using Zingtree’s Zendesk CSS Theme

For the best user experience, we recommend using the Zendesk Apps theme in your trees that display inside of Zendesk. This will give you more room for your content (since the fonts are smaller), and also match the look and feel of the rest of the Zendesk experience.

Here’s how the theme looks in the two style options:

To include the Zendesk Agent Scripting App theme in your trees, do the following:

1. In Zingtree, open the Settings tool for your tree.
2. Click the Display tab.
3. Choose either Buttons or Panels as the Default Display Style.
4. Click Pick a Color Theme.
5. Choose Zendesk Agent Scripting as the theme.
6. Click Save Theme and Colors.
7. Click Update Settings.

Try It with Example Data

You can use trees from the Zingtree Gallery to see how the Agent Scripting app works.

This Zendesk Agent Scripting Demo shows how to implement some of the basic integration features. You can install it into your own Zendesk configuration by entering tree ID 350546744 in the App Configuration.

For multiple trees, see how a tree can be selected by tag by doing the following:

1. In the App Configuration, enter 6a103737e44e4aa6e1e4b6b0bcb46f83 as the API key. Also make sure Match Tree Tags to Zendesk Ticket Tags is checked.
2. Try entering one or more of these tags into a ticket: “zingtree”, “astrology”, “pet_rock”.

Any questions? We’re always here to help.