Input Parameters in Widgets

Widgets is a feature in Zoho SalesIQ that lets you display different categories of information required for your operator right inside their live chat window. These widgets can be built either using Deluge or using Webhooks. There are 5 different input parameters used in Widgets and they are as follows:

Action
Target
Context
Environment
Operator

Action:

The action parameter contains the details of the action that was performed. This parameter will be available inside the Action Handler.

Details found:

The type of action that was performed - search, button, navigate or navigate_back
The search query in case the action type is search
Button name or list element name that was clicked or triggered during the action

Sample Code:

{

"type" : "search | button | navigate|navigate_back",

"text" : $search_query, // for search

"name" : $button_name | $listElementName,

}

Target:

This parameter contains the details of the section & the element from which the action was performed. This parameter will be available inside the Action Handler.

Details found:

Name of the section in which the action is performed
Reference ID of the element from which the action is performed
Reference ID of the section in which the action is performed
Reference ID of the action performed

Sample Code:

{

"type" : "search | button | navigate|navigate_back",

"text" : $search_query, // for search

"name" : $button_name | $listElementName,

}

Context:

This parameter contains the details of the context for which the widget is being invoked. The context object will be different for different entities of SalesIQ. This parameter will contain the ID and data about the conversation for which the widget is being executed. And this parameter is available in the message handler.

Details found:

The type of entity for which the context is being invoked
Unique ID for the entity
Object that contains the entity data based on the context.

Sample Code:

{

"data":{

"email_id":"zillium.pboyle@zylker.com",

"phone":"18147471717"

"id":"403000208743933",

"type":"conversation"

}

Environment:

This parameter contains the details of the environment in which the widget is being accessed. It is available in the detail handler and in the action handler.

Details found:

Data center in which the portal exists
Language of the operator viewing/accessing the widget
Environment in which the operator has accessed SalesIQ

Sample Code:

{

"datacenter" : "us/eu/cn",

"language" : "en/jp/cn",

"client" : "mobile/web/tablet"

}

Operator:

This parameter contains the details of the operator who is accessing the widget. It is available in the detail handler and in the action handler.

Details found:

Email address of the operator accessing the widget
Unique ID of the operator viewing/accessing the widget
Role of the operator accessing the widget

Sample Code:

{

"email_id" : "zillium.pboyle@zylker.com",

"id" : "403000083293647",

"role" : "Administrator"

}

Related Posts:

To learn more about Widgets, check out our Help Documentation.

Regards,

Michelle

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Topic Participants
Michelle Concetta Fernando

Sticky Posts
Qualify Potential Leads Automatically with SalesIQ Chatbots
Your website may have a lot of visitors every day, but are you struggling to identify your potential leads? You may not know who your ideal leads are just by looking at a website visitor, right? To qualify a lead, you need to know their needs, interests,
OpenAI Alert! Plug Sample #11 - Next-generation chatbots, Zobot + ChatGPT Assistant
Hi Everyone! We have great news for all AI enthusiasts and ChatGPT users! The much anticipated Zobot integration with ChatGPT Assistant is now available with Plugs. OpenAI has introduced 'ChatGPT Assistants' to customize GPT models as per your requirement.
Get live insights on business performance with the SalesIQ TV App - Now available for Apple and Android TVs!
Hello everyone! Let's start with a question - What do you think is the key to a thriving business? Yes, I hear you. It's all about the customers. Success in business often starts with understanding customer needs. But wouldn't you agree that achieving
Deprecation of Google Drive and Sheets connections in Scripts (Deluge)
Hello Everyone, We have an important update for those using the Script (Deluge) platform to build chatbots, widgets, and forms. Google has alerted us about sensitive scopes within the Google Drive and Google Sheets default connections in Deluge. As a
Plug Sample #10 - Simplify Ticket Management (Zoho Desk) with Chatbots
Hi everyone! We're here with another simple yet effective plug for your chatbot to integrate with Zoho Desk. When a customer reports an issue/request during chat, it's logged as a ticket on Desk. When they return for updates, you end up searching through