Get practical tips to improve your customer service strategy at Zoho CX Workshop.

Register now!
Skip to product menu
close
  • Sales
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

UI Methods

This method helps to trigger any of the desk UI actions from the widget.

Available UI actions  are:

 

ROUTE_TO

This API allows you to navigate to the add forms page of different static modules such as ticket, contact, account and more that are available in the desk portal and to specific sub-tabs in the ticket details view page. It also helps you open another widget of the extension. This API accepts two types of arguments: string and JSON object.

This API is supported for the given locations: desk.topband, desk.ticket.detail.subtab, desk.ticket.detail.lefttab, desk.bottomband, and desk.extension.telephony.

Using this API you can route to: 

Note: The target key given in the sample request helps to determine where the resulting page or action should be displayed based on its value. For example, if the target key value is '_blank', the ticket add form will open in a new tab.

Route to Add Form Pages

These properties allow you to navigate to the add forms page of multiple modules like ticket, article, contact, account, call, task, event, topic, and solution that are available in add (+) drop-down list of desk portal.

In the widget file, these properties can be given in the below format:

  • ticket.addForm
  • contact.addForm
  • account.addForm
  • task.addForm
  • topic.addForm
  • event.addForm
  • solution.addForm
 

Route to Ticket Detail View Sub-Tabs 

These properties allow you to navigate within the sub-tabs available in ticket detail view page of the desk portal.

In the widget file, these properties can be given in the below format:

  • ticket.history
  • ticket.task
  • ticket.attachments
  • ticket.timeEntry
  • ticket.resolution
  • ticket.threads
  • ticket.conversation
  • ticket.approval
  • ticket.suggestedArticles
  • ticket.properties
  • ticket.timeline

Sample Request

Copied//Route to add form page in same tab

ZOHODESK.invoke("ROUTE_TO", "ticket.addForm");

//Route to History Subtab in same tab

ZOHODESK.invoke("ROUTE_TO", "ticket.history");

//Route to add form page in new tab using Target key

ZOHODESK.invoke("ROUTE_TO", {entity : "ticket", page : "add", target : "_blank"});
 

Route to Add/Edit/Detail View Pages (using entity Id)

You have the option to navigate the page by the record id, whose properties are given below:

ParamDescription
entityName of the entity. Values allowed are: ticket, contact, account, call, task, and event.
idID of the record to navigate to. This parameter is not needed for the add action
pagePage to open. Values allowed are add and edit. Default value is dv (detail view).

 

Sample Request

Copied//Route to ticket edit page with ticket id
ZOHODESK.invoke("ROUTE_TO" , {
		entity : "ticket",
		id : "31138000012704001", //id of record to navigate
		page : "edit" //page to open
	})
 

Route to Widgets

You can open/navigate to the extension widget from another widget.

ParamDescription
entityName of the entity. The value is extension.
locationThe location name of the widget to be opened, as specified in plugin-manifest.json.
nameThe unique name of the widget to be opened, as specified in plugin-manifest.json.

 

Sample Request

CopiedZOHODESK.invoke("ROUTE_TO" , {
		entity : "extension",
		location : "desk.ticket.detail.subtab", //invoke location
		name : "subtab-widget" //name of the widget 
	})
 

SHOW

This API shows/opens the widget programmatically from the extension source. It's specifically used for chat/call based extensions. For example, if any message/call is received, then the widget can be opened automatically by the developer.

It can be supported in desk.ticket.detail.rightpanel, desk.ticket.detail.moreaction, desk.ticket.thread.moreaction, desk.bottomband, and desk.extension.telephony locations.

 

Sample Request

CopiedZOHODESK.invoke("SHOW");
 

HIDE 

This API hides/closes the widget programmatically from the extension source. For example, it will be useful when some background operations are done or when a widget is closed based on some other action.

It will work for the following locations : desk.ticket.detail.rightpanel, desk.ticket.detail.moreaction, desk.ticket.thread.moreaction, desk.bottomband, and desk.extension.telephony.

Sample Request

CopiedZOHODESK.invoke("HIDE");
 

MINIMIZE 

This api allows you to minimize the widget. It works only in desk.bottomband and desk.extension.telephony locations.

Sample Request

CopiedZOHODESK.invoke("MINIMIZE");
 

MAXIMIZE

This api allows you to maximize the widget. It works only in desk.bottomband and desk.extension.telephony locations.

Sample Request

CopiedZOHODESK.invoke("MAXIMIZE");
 

RESIZE

This API allows you to resize the height and width of the widget.

Note:
For all Right Panel widgets, the height gets resized according to the content and it has a default max height (545 px).
For desk.extension.telephony location both height and width gets resized.
For modal box widget, the width and height get resized to the specified width and height.
Width and Height values can only be denoted in px (pixels), % (percentage), vh (viewport height), and vw (viewport width) formats.

Sample Request

Copied//without width and height specified

ZOHODESK.invoke("RESIZE");


//with width and height specified

ZOHODESK.invoke("RESIZE", {width: "40%", height: "50%"});

MODAL_CLOSE

This API closes the modal widget programmatically from the extension source.

Sample Request

CopiedZOHODESK.invoke("MODAL_CLOSE");


Note: Always enter the API names in capital letters with an underscore if they contain multiple words. Entering the api names in small letters or with any misspelling will give you an "Invalid Path" error message.