Chat Triggers

Owned by Valerio Ciotta
Last updated: Jun 07, 2022 by XCALLY Knowledge (Unlicensed)
6 min read

What is a Chat Trigger

   A chat trigger is invoked every time there is an outgoing or incoming interaction.

The trigger will execute its actions if the defined conditions are met. Here are few applications of chat triggers:

  • displaying Screen Pop-up that provides value added information
  • opening custom browser web pages 
  • integrate with other 3rd party applications like your own CRM

Chat triggers are composed of conditions and actions. This section explains how to build conditions and the available actions for the chat channel.


On this page:

Chat trigger conditions

A condition for the chat channel is constructed by using properties like Account, Interaction or Message, an operator and a value.  

There are two types of conditions: 

  • Meet all these conditions: the overall condition will be true only if all the conditions are true.
  • Meet any of these conditions: the overall condition will be true if at least one of the conditions is true. 


It is possible to specify more complex conditions by using both types: in this case, the result is true if both conditions are true.

In the example shown below, the overall condition is true if the call is in Support or Sales queue and the call is answered.


The condition will always return true if you do not define any condition. In this case, the specified actions will always be executed.



You can use the following fields and operators to build condition statements:


Fields

Operators

Values

Account

Equals to

Not equals to

  • Select from list (the Account must be already existing)
Interaction

Equals to

Not equals to

  • Opened
  • Closed
Message

Equals to

Not equals to

  • Incoming 
  • Outgoing
  • Accepted
  • Rejected
Offline Message

Equals to

Not equals to

  • Created




Chat trigger actions


Chat trigger actions are functions executed when the defined chat trigger conditions are true.

The following are the actions that can be triggered:

  • Motion (Phone)Bar
  • Jscripty
  • URL Forward
  • Browser
  • Script


Motion Phonebar

Motion Phonebar action is used to notify the Omnichannel Motion Phonebar to perform actions like:

  • screen Popup display
  • Windows Application execution
  • CTI URL open in a web browser


Popup

Popup action is used to display a customizable screen popup for agents logged in the Phonebar.

You must previously create a template (Tools → Templates) with information you want to be displayed for agents.

You can also use standard and custom variables in your template  to customize the displayed content based on the values of the variables set during the call flow. 



CTI URL

CTI URL action is used to open a specified URL in a browser.  This can be used to open a website, your custom CRM url or integrate with any other web application. You can use standard or custom variables in the URL query string to pass information to the web application that can be useful for processing its logic.

CTI URL action is used to open a specified URL in a browser New Tab or New Window (Location).  

It can be used to open a website, your custom CRM url or integrate with any other web application.

You can use standard or custom variables in the URL query string to pass information to the web application that can be useful for processing its logic:

  • If the Event Variables field is set to Yes, the string in the URL field is merged with all the available interaction type values (pay attention that it add to the URL string the complete variables list: it is not recommended unless for evaluation purposes).
  • If the Event Variables field is set to No (suggested value), only the variables inserted in the URL field are used.



In the following example, variables in bold are Motion standard variables and those red are custom variables:

  http://ip-address/cti/index.html?CALLID={{uniqueid}}&CALLER={{calleridnum}}&QUEUE={{queue}}&ORDER={{ORDERNUM}}&STATUS={{ORDERSTAT}}


Tip: remember to set the Event Variables to No


Windows App

Windows App action is used to execute or open a windows application with the specified arguments in the agent desktop.

You can use standard or custom variables to pass custom information in the arguments.





Agents must be logged in the Motion Phonebar to make the Motion Phonebar actions work





Custom variables must be defined under Tools → Variables then you can set the values in the dialplan or in IVR project.




Jscripty

Jscripty action is used to start a Jscripty project execution (it must be already existing and chosen from the proposed list):




URL Forward

The URL Forward action is used to perform RESTful API requests, generally if you want to contact a third party applications such as a CRM to retrieve or save information.


Fill the the URL Forward form as follows:

Option

Description

TypeHTTP Method (GET, POST, PUT or DELETE)
URL

Request URL

You can also use XCALLY Motion standard variables or custom variables to pass information to the 3rd party application
TimeoutRequest timeout in seconds (it must be between 1 and 10 and the default value is 5)

Headers

Request headers (it must be in RAW JSON format, i.e. {"key": "value"})

You can also use XCALLY Motion standard variables or custom variables to pass information to the 3rd party application

Body

Request body (it must be in RAW JSON format, i.e. {"key": "value"})

This option is available only for POST and PUT methods. If empty, the trigger event will be passed as body request.

You can also use XCALLY Motion standard variables or custom variables to pass information to the 3rd party application
Please note URL Forward supports request with Content-Type equal to application/json





You can also use Motion standard variables or custom variables to pass information to the 3rd party application.  


Browser

Browser action is used to display screen popup or open a URL in a web browser for agents logged in the web interface.

This action does not require agents to be logged in Motion Phonebar, but the Agents must be logged in the Motion Omni Desktop Interface for the actions to run.




There are 2 types of Browser Actions:

  • Popup
  • CTI URL

Popup

Popup action is used to display a customizable screen popup for agents logged in Motion omni desktop interface.

You must first create a template (Tools → Templates) with information you want to be displayed for agents. You can also use standard and custom variables in your template to customize the displayed content based on the values of the variables set during the interaction. 

CTI URL

CTI URL action is used to open a specified URL in a New Tab / New Window of a Browser or in a New Agent Dashboard Tab in the Agent Omni Desktop interface (you can choose this value in the field Location).

It can be used to open a website, your custom CRM url or integrate with any other web application.

You can use standard or custom variables in the URL query string to pass information to the web application that can be useful for processing its logic:

  • If the Event Variables field is set to Yes, the string in the URL field is merged with all the available interaction type values (pay attention that it add to the URL string the complete variables list: it is not recommended unless for evaluation purposes).
  • If the Event Variables field is set to No (suggested value), only the variables inserted in the URL field are used.



In the following example, variables in bold are Motion standard variables and those red are custom variables:

  http://ip-address/cti/index.html?CALLID={{uniqueid}}&CALLER={{calleridnum}}&QUEUE={{queue}}&ORDER={{ORDERNUM}}&STATUS={{ORDERSTAT}}



Tip: remember to set the Event Variables to No



Script

The Script action allows you to define which script must be run when the trigger is started:

Enter the following information:

  • Type: e.g. curl, bash, or other
  • Info: an optional script description
  • Script: the path of the script to be executed