From Bright Pattern Documentation
Jump to: navigation, search
(Updated via BpDeleteTranslateTags script)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
<translate>= Using Zendesk Integration Scenario Blocks =
+
= Using Zendesk Integration Scenario Blocks =
A scenario is a script that defines the logic of automated processing of interactions satisfying some specific criteria (e.g., inbound interactions arriving at a specific access point). In Bright Pattern Contact Center software, scenarios are used to map out the sequence of actions that may occur during an interaction (voice, chat, SMS, etc.), with all the possible options, exits, prompts, and so forth, that could be presented to a user or customer.
+
In Bright Pattern Contact Center software, scenarios are used to map out the sequence of actions that may occur during an interaction (voice, chat, SMS, etc.), with all the possible options, exits, prompts, and so forth, that could be presented to a user or customer.
  
Scenarios are built and defined in the Bright Pattern Contact Center Scenario Builder application, which is available via the Bright Pattern Contact Center Administrator application. You can create your own scenario from scratch, or you can use a template scenario (easier) and then customize it to suit your needs. Scenarios are constructed using "blocks," which you can learn about in more detail in the ''[[scenario-builder-reference-guide/ScenarioBuilderOverview|Scenario Builder Reference Guide]]''.
+
Scenarios are built and defined in the Scenario Builder application, which is launched from the Bright Pattern Contact Center Administrator application. You can create your own scenario from scratch, or you can use a template scenario template and then customize it to suit your needs. Scenarios are constructed using "blocks," which you can learn about in more detail in the ''[[scenario-builder-reference-guide/ScenarioBuilderOverview|Scenario Builder Reference Guide]]''.
  
For the purpose of this ''Zendesk Integration Guide'', let's consider the [http://www.brightpattern.com/zendesk-integrations/Zendesk integration] scenario blocks that could be used in a simple scenario involving look-ups to recognize the customer and screen-pop of the customer's Zendesk data.
+
== Objective ==
 +
The objective of this section is to examine Zendesk integration scenario blocks that look up a customer's Zendesk data, recognize the customer, and screen-pop it to an agent.
 +
 
 +
As a reminder, in order for your Zendesk scenario to work, you must complete all the integration and configuration steps as noted in this guide. These instructions are available in the following articles.
 +
*[[Zendesk-integration-guide/Prerequisites|Prerequisites]]
 +
*[[Zendesk-integration-guide/ZendeskIntegrationSetup|Zendesk Integration Setup]]
 +
*[[Zendesk-integration-guide/SingleSign-OnSetup|Single Sign-On Setup]]
 +
*[[Zendesk-integration-guide/Screen-PopConfiguration|Screen-Pop Configuration]]
 +
*[[Zendesk-integration-guide/AccessingZendeskDatafromScenarios|Accessing Zendesk Data from Scenarios]]
 +
 
 +
== Zendesk Scenario Blocks Overview ==
 +
The following Zendesk blocks are available in the Scenario Builder application:
 +
* [[Scenario-builder-reference-guide/ScenarioBlocks/ZendeskAPIRequest|Zendesk API Request]], which allows you to submit a free-form Zendesk API request to Zendesk using JSON.
 +
* [[scenario-builder-reference-guide/ZendeskSearch|Zendesk Search]], which allows you to obtain data from your Zendesk account
 +
* [[scenario-builder-reference-guide/ZendeskCreateObject|Zendesk Create Object]], which allows you to create new tickets and users in Zendesk
 +
* [[scenario-builder-reference-guide/ZendeskUpdate|Zendesk Update Object]], which allows you to update existing Zendesk tickets and users
 +
* [[scenario-builder-reference-guide/ZendeskScreenPop|Zendesk Screen Pop]], which allows you to synchronize the delivery of calls and related Zendesk records to the agents
 +
* [[scenario-builder-reference-guide/AttachedData|Attached Data]], which allows you to populate custom fields in Zendesk activity history; note that this block may be used with other CRM integrations
  
 
== Zendesk Scenario Building Notes ==
 
== Zendesk Scenario Building Notes ==
 
When building your Zendesk scenario, note the following:
 
When building your Zendesk scenario, note the following:
 
* The Zendesk scenario blocks function the same whether they are used in voice or chat scenarios.  
 
* The Zendesk scenario blocks function the same whether they are used in voice or chat scenarios.  
* Zendesk scenario blocks work best when configured with other Zendesk scenario blocks, either in pairs or in a series. For example, if you want to search your Zendesk account for a customer’s contact information, then pop the contact information search results to the agent, your scenario would need both the ''Zendesk Search'' block and ''Zendesk Screen Pop'' block.  
+
* Zendesk scenario blocks work best when configured with other Zendesk scenario blocks, either in pairs or in a series. For example, if you want to search your Zendesk account for a customer’s contact information, then pop the contact information search results to the agent, your scenario would need both the ''Zendesk Search'' block and the ''Zendesk Screen Pop'' block.  
* Using the ''Zendesk Screen Pop'' block, you can make the scenario pop a new ticket every time the customer calls/chats, but you don’t have to do it that way. It may be enough to pop the customer’s contact info so you don’t have so many tickets.
+
* Using the ''Zendesk Create Object'' block, you can make the scenario pop a new ticket every time the customer calls/chats, but you don’t have to do it that way. It may be enough to search for and pop the customer’s contact info so you don’t have so many tickets.
 
 
== Example Voice Scenario ==
 
What follows is the sequence of actions that could occur in a basic voice scenario flow.
 
 
 
 
 
'''Click the following link to download a version of this Zendesk voice scenario example.'''<br>
 
[[File:App_Zendesk_Search_and_Pop_(Voice).zip|Download Zendesk Search and Pop (Voice)]]
 
 
 
 
 
'''Action 1: An inbound call comes in, and the customer is prompted for information.'''
 
 
 
 
 
[[File:Collect-Digits-Block.png|200px|Collect Digits scenario block]]
 
 
 
 
 
A customer calls Bright Pattern Support. (For simplicity, service hours verification is omitted, and agent skill requirements are identified by the dialed number.) The customer is greeted with a [[scenario-builder-reference-guide/CollectDigits|Collect Digits]] block with the following prompt: ''Welcome to Bright Pattern support. If you are calling about an existing case and have the case number, please enter it now followed by the pound sign. Otherwise please remain on the line.''
 
 
 
 
 
 
 
'''Action 2: The customer does not enter a case number, so the scenario identifies the customer by caller ID.'''
 
 
 
 
 
[[File:Zendesk-Search-Block.png|200px|Zendesk Search scenario block]]
 
 
 
 
 
If the customer does not enter any digits, a [[scenario-builder-reference-guide/ZendeskSearch|Zendesk Search]] block is used to recognize the customer by ANI (Caller ID).
 
 
 
 
 
[[File:zendesk-integration-guide-customer-search.png|thumb|400px|center|Customer identification by ANI]]
 
 
 
 
 
 
'''Action 3: The customer's data is pulled from Zendesk data and popped to the agent.'''
 
 
 
 
 
[[File:Zendesk-Screen-Pop-Block.png|200px|Zendesk Screen Pop scenario block]]
 
 
 
 
 
If the customer record is found, a [[scenario-builder-reference-guide/ZendeskScreenPop|Zendesk Screen Pop]] block is used to pop the customer record into the Zendesk application of the agent that will receive the call. The call is then sent to the service queue.
 
 
 
 
 
[[File:Zendesk-integration-guide-customer-pop.PNG|thumb|800px|center|Customer record screenpop]]
 
 
 
 
 
 
'''Action 4: The scenario looks up case/ticket data.'''
 
 
 
 
 
[[File:Zendesk-Search-Block.png|200px|Zendesk Search scenario block]]
 
 
 
 
 
If the ticket number is entered, a [[scenario-builder-reference-guide/ZendeskSearch|Zendesk Search]] block is used to look up the ticket information.
 
 
 
 
 
[[File:zendesk-integration-guide-ticket-search.PNG|thumb|800px|center|Ticket search by ticket number]]
 
 
 
 
 
 
 
'''Action 5: The customer is directed to a menu.'''
 
 
 
 
 
[[File:Menu-Block.png|200px|Menu scenario block]]
 
 
 
 
 
A [[scenario-builder-reference-guide/Menu|Menu]] block is then used with the following prompt: ''Thank you. We have found the ticket with subject $(zdTicket.subject). For the status of this ticket, press 1. For any other inquiries, press 2 or stay on the line.''
 
 
 
 
 
 
 
'''Action 6: A prompt regarding ticket status is played to the customer.'''
 
 
 
 
 
[[File:Play-Prompt-Block.png|200px|Play Prompt scenario block]]
 
 
 
 
 
If the self-service is selected, a [[scenario-builder-reference-guide/PlayPrompt|Play Prompt]] block is used to inform the customer about the current ticket status: ''The current status of this ticket is $(zdTicket.status). Thank you for your inquiry. Goodbye.'' The call is then marked as self-served and released.
 
 
 
 
 
 
 
'''Action 7: The customer's ticket/case information is popped to the agent.'''
 
 
 
 
 
[[File:Zendesk-Screen-Pop-Block.png|200px|Zendesk Screen Pop scenario block]]
 
 
 
 
 
If the customer needs the agent's help, a [[scenario-builder-reference-guide/ZendeskScreenPop|Zendesk Screen Pop]] block is used to pop the ticket to the Zendesk application of the agent who will receive the call. The call is then sent to the service queue.
 
 
 
 
 
[[File:zendesk-integration-guide-ticket-pop.PNG|thumb|800px|center|Ticket screenpop]]
 
 
 
 
 
 
 
'''The Complete Voice Scenario'''
 
 
 
The diagram shown illustrates what a complete scenario looks like when designed in the Scenario Builder application.
 
 
 
 
 
[[File:Zendesk-integration-guide-scenario1.PNG|thumb|550px|center|]]
 
 
 
 
 
== Example Chat Scenario ==
 
The following is an example of the sequence of actions that could occur in a basic chat scenario flow.
 
 
 
 
 
'''Click the following link to download an annotated version of this Zendesk chat scenario example.'''<br>
 
[[File:App_Zendesk_Create_and_Pop_User_(Chat).zip|Zendesk Create and Pop User (Chat)]]
 
 
 
 
 
[[File:Zendesk-Chat-Pre-Chat-Form-53.PNG|650px|thumb|center|The pre-chat form used in this scenario, as seen by the customer]]
 
 
 
 
 
'''Action 1 (Optional): A customer fills out a pre-chat form with their first name, last name, email address, and a brief message; the brief message should go to the agent.'''
 
 
 
 
 
[[File:Zendesk-Chat-If-53.PNG|225px|If block]]
 
 
 
[[File:Zendesk-Chat-Set-Variable-53.PNG|225px|Set Variable block]]
 
 
 
 
 
Using an [[Scenario-builder-reference-guide/If|If]] block, the scenario searches the pre-chat form to see if the message field is empty or not. Then, if the field is not empty, the [[Scenario-builder-reference-guide/SetVariable|Set Variable]] block is told to treat what was entered in the field as a chat message; this is done by resetting the value to [[Scenario-builder-reference-guide/Variables#.24.28item.newMessage.29|item.newMessage]].
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-1-53.PNG|800px|thumb|center|If block configuration]]
 
 
 
 
 
While it is not necessary to include a message field on a [[Chat-widget-configuration-guide/ContactTab#Pre-Chat_Form_Configuration|pre-chat form]], you may find it useful for your agents, as well as for reporting purposes.
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-2-53.PNG|800px|thumb|center|Set Variable block configuration containing ''item.newMessage'']]
 
 
 
 
 
 
 
'''Action 2: The scenario searches for matching customer information in Zendesk.'''
 
 
 
 
 
[[File:Zendesk-Chat-Zendesk-Search-53.PNG|225px|Zendesk Search block]]
 
 
 
 
 
Next, using a [[Scenario-builder-reference-guide/ZendeskSearch|Zendesk Search]] block, the scenario searches in your Zendesk account for customer information entered on the pre-chat form. In this instance, the block will search in Zendesk for a customer whose email address matches the one entered in the pre-chat form’s email field; the results are returned to the variable entered in the ''Recordset name'' field.
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-3-53.PNG|800px|thumb|center|Zendesk Search block configuration]]
 
 
 
 
 
 
 
'''Action 3: The customer information from the Zendesk search is configured to pop to the agent.'''
 
 
 
 
 
[[File:Zendesk-Chat-Zendesk-Screen-Pop-53.PNG|225px|Zendesk Screen Pop block]]
 
 
 
 
 
If the search for a matching customer email address is successful, you will want the search results to pop on the agent’s screen. This is done with the [[Scenario-builder-reference-guide/ZendeskScreenPop|Zendesk Screen Pop]] block. In this example, the variable from the ''Recordset name'' field in the ''Zendesk Search'' block is used to pop the ID of the user (i.e., customer) to the agent. Note that if you want this information to pop, check the box '''Pop screen upon answer'''.
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-4-53.PNG|800px|thumb|center|Zendesk Screen Pop block configuration]]
 
 
 
 
 
 
 
'''Action 4: The scenario finds an agent available to take the chat and pop the Zendesk search information to.'''
 
 
 
 
 
[[File:Zendesk-Chat-Find-Agent-53.PNG|225px|Find Agent (Chat) block]]
 
 
 
 
 
Next, the scenario searches for an available agent to receive the chat and the Zendesk search information using the [[Scenario-builder-reference-guide/FindAgent|Find Agent]] block. Note that this block is useful for skill-based routing. In this example, no settings are configured, so the interaction will be routed to the first available agent.
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-5-53.PNG|650px|thumb|center|Find Agent block configuration]]
 
 
 
 
 
 
 
'''Action 5: The agent is connected to the chat with the customer.'''
 
 
 
 
 
[[File:Zendesk-Chat-Connect-Chat-53.PNG|225px|Connect Chat block]]
 
 
 
 
 
After finding an available agent, the scenario uses the [[Scenario-builder-reference-guide/ConnectChat|Connect Chat]] block to connect the agent to the customer. It is at this time that the information from the ''Zendesk Search'' block is popped to the agent. Note that in this example no additional settings are configured.
 
 
 
As a general reminder, the ''Find Agent'' block and ''Connect Chat'' block (or ''Connect Call'' block, if in a voice scenario) are meant to work together. That is, these blocks should be arranged in a scenario with no other blocks between them.
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-6-53.PNG|650px|thumb|center|Connect Chat block configuration]]
 
 
 
 
 
The following image is what the agent sees in Zendesk when the chat is connected and the screen pops with the customer's information.
 
 
 
 
 
[[File:Zendesk-Chat-Zendesk-53.PNG|800px|thumb|center|The agent's view of Zendesk with the chat message from the pre-chat form and the popped search results]]
 
 
 
 
 
 
 
'''Action 6: The scenario ends.'''
 
 
 
 
 
[[File:Zendesk-Chat-Exit-53.PNG|225px|Exit block]]
 
 
 
 
 
Finally, when either the agent or the customer ends the chat, the scenario will end; this is defined by using the [[Scenario-builder-reference-guide/Exit|Exit]] block. Bright Pattern generally recommends to always terminate a scenario or scenario branch that should not continue with an ''Exit'' and not rely on the customer to do so. That is, it is good practice to end scenarios and conditional exists because you always want to know what your scenario will do in any given situation. An ''Exit'' block will forcibly terminate the scenario wherever it is used.
 
 
 
 
 
 
 
'''The Complete Chat Scenario'''
 
 
 
The diagram shown illustrates what a complete scenario looks like when designed in the Scenario Builder application.
 
 
 
 
 
[[File:Zendesk-Chat-Scenario-Complete-53.PNG|800px|thumb|center|Example Zendesk chat scenario overview]]
 
 
 
 
 
For more information about scenarios, refer to the ''[[scenario-builder-reference-guide/ScenarioBuilderOverview|Scenario Builder Reference Guide]]''.
 
 
  
</translate>
+
== Zendesk Scenario Examples ==
 +
As with any scenario, Zendesk scenarios can be as simple or as elaborate as you would like them to be. For a better understanding of how Zendesk scenario blocks work within both voice and chat scenarios, Bright Pattern has simple Zendesk scenario examples available for you to study and download.
 +
* [[Zendesk-integration-guide/ExampleZendeskVoiceScenario|Example Voice Scenario: Search for and Pop Zendesk Ticket]]
 +
* [[Zendesk-integration-guide/ExampleZendeskChatScenario|Example Chat Scenario: Search for and Pop Zendesk User]]

Latest revision as of 04:04, 29 May 2024

• 5.19 • 5.2 • 5.3 • 5.8

Using Zendesk Integration Scenario Blocks

In Bright Pattern Contact Center software, scenarios are used to map out the sequence of actions that may occur during an interaction (voice, chat, SMS, etc.), with all the possible options, exits, prompts, and so forth, that could be presented to a user or customer.

Scenarios are built and defined in the Scenario Builder application, which is launched from the Bright Pattern Contact Center Administrator application. You can create your own scenario from scratch, or you can use a template scenario template and then customize it to suit your needs. Scenarios are constructed using "blocks," which you can learn about in more detail in the Scenario Builder Reference Guide.

Objective

The objective of this section is to examine Zendesk integration scenario blocks that look up a customer's Zendesk data, recognize the customer, and screen-pop it to an agent.

As a reminder, in order for your Zendesk scenario to work, you must complete all the integration and configuration steps as noted in this guide. These instructions are available in the following articles.

Zendesk Scenario Blocks Overview

The following Zendesk blocks are available in the Scenario Builder application:

  • Zendesk API Request, which allows you to submit a free-form Zendesk API request to Zendesk using JSON.
  • Zendesk Search, which allows you to obtain data from your Zendesk account
  • Zendesk Create Object, which allows you to create new tickets and users in Zendesk
  • Zendesk Update Object, which allows you to update existing Zendesk tickets and users
  • Zendesk Screen Pop, which allows you to synchronize the delivery of calls and related Zendesk records to the agents
  • Attached Data, which allows you to populate custom fields in Zendesk activity history; note that this block may be used with other CRM integrations

Zendesk Scenario Building Notes

When building your Zendesk scenario, note the following:

  • The Zendesk scenario blocks function the same whether they are used in voice or chat scenarios.
  • Zendesk scenario blocks work best when configured with other Zendesk scenario blocks, either in pairs or in a series. For example, if you want to search your Zendesk account for a customer’s contact information, then pop the contact information search results to the agent, your scenario would need both the Zendesk Search block and the Zendesk Screen Pop block.
  • Using the Zendesk Create Object block, you can make the scenario pop a new ticket every time the customer calls/chats, but you don’t have to do it that way. It may be enough to search for and pop the customer’s contact info so you don’t have so many tickets.

Zendesk Scenario Examples

As with any scenario, Zendesk scenarios can be as simple or as elaborate as you would like them to be. For a better understanding of how Zendesk scenario blocks work within both voice and chat scenarios, Bright Pattern has simple Zendesk scenario examples available for you to study and download.