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

Plugin Manifest


The plugin-manifest.json file helps you store all the configuration information for the extension. The various keys included in this file are as follows:
 

plugin-manifest.json

Copied{
  "locale": [
    "en",
    "ta"
  ],
  "service": "DESK",
  "storage": false,
  "whiteListedDomains": [
    "https://webhook.site",
    "https://desk.zoho.com"
  ],
  "modules": {
    "widgets": [
      {
        "location": "desk.ticket.detail.rightpanel",
        "url": "/app/widget2.html",
        "name": "Desk Extension",
        "logo": "/app/img/logo.png",
        "icon": "/app/img/icon.png"
      }
    ]
  },
  "cspDomains": {
    "connect-src": []
  },
  "zohoAuthorisation": {
    "type": "connectors",
    "connectionLinkName": "zohodesk",
    "connectionName": "zohodesk",
    "serviceName": "zlabs_integration",
    "userAccess": true,
    "isUserDefinedService": false,
    "sharedBy": "1234567",
    "scope": [
      "Desk.tickets.ALL"
    ]
  },
  "connectors": [
    {
      "connectionLinkName": "woocommtest",
      "connectionName": "woocommtest",
      "serviceName": "woocommerce",
      "userAccess": true,
      "isUserDefinedService": false,
      "sharedBy": "1234567"
    }
  ],
  "config": [
    {
      "displayName": "API Key",
      "name": "apikey",
      "secure": true,
      "type": "text",
      "description": "To get the api key [visit here](https://test.requestcatcher.com)",
      "mandatory": true,
      "userdefined": true,
      "authType": "org"
    }
  ],
  "moduleSupport": false,
  "updateBefore": "2024-01-15T04:49:09.963Z",
  "secret":"mysecretkey"

}

Show full

Show less

 

Locale 

Locale is used for language support in the extension. If you wish to support multiple languages in your extension, you must store all translation files in the '{{Locale Code}}.json' (for e.g., {{en}}.json) format inside the translations folder of the extension's project app folder (/app/translations). This will return the corresponding language file based on the country locale and language selected by the user in the Personal Settings preferences.

Refer below for the list of supported languages.

LanguageLocale Code
Englishen
Japaneseja
Chinese (China)zh
Chinese (Taiwan)tw
Spanish (Spain)es
Germande
Frenchfr
Turkishtr
Russianru
Portuguese (Brazil)pt
Italianit
Dutchnl
Danishda
Polish (Poland)pl
Swedishsv
Bahasa Indonesiaid
Hindihi
Romanianro
Tamilta
Telugute
Hebrew (Beta)he
Arabic (Beta)ar

Default value of the extension locale - [ 'en' ] 

Copied"locale": [
    "en",
    "ta"
  ]
 

Service 

This key defines the ZOHO service for which this extension is created. By default, an entry "service": "DESK" is given in the plugin-manifest file.

Copied"service": "DESK"
 

Storage 

This key determines whether the extension will utilize data storage. It is of the Boolean type.

By default, it is set to False. If storage is set to True, it enables you to store data that can be utilized within your extension.

For more information on storage, click here.

Copied"storage": true
 

White Listed Domains

Access to data from Zoho Desk and third-party services is made possible through Request Method. Only domains specified under the 'whiteListedDomains' key are allowed to make API calls. Requests from domains not included in this key will not be processed. If your extension does not require requests to third-party services, you can declare this key as an empty array.

*Info: Mention only the domain as given in the sample; no need to provide the whole URL.

Copied"whiteListedDomains": [
    "https://webhook.site",
    "https://desk.zoho.com"
  ]


 

Dynamic White Listed Domains

You may not always be aware of the domain you need to add ahead of time. Assume you need to obtain the user input for the domain that the customer is using to make the API call. In that case, you couldn't add it to whitelistedDomains as a static value. As a solution for this, whiteListedDomains can be added dynamically.

This can be achieved by getting the domain from user as  a config param and adding it directly to the plugin manifest as the example below.

The Domain url entered in the configParam will be used in whiteListedDomains dynamically.

Copied//Config Param entry

"config": [{
  "displayName":"Domain url",
  "name": "domainurl",
  "secure": true,
  "type":"text",
  "description": "Copy your Domain Url Here  (https://{domainurl})",
  "mandatory": true,
  "userdefined": true,
  "authType" : "org"
}]

//whiteListedDomains entry

"whiteListedDomains": [
    "https://{{domainurl}}"
  ],
 

Modules 

The extension currently includes only widgets as its modules. However, in the future, buttons, menus, and tabs will also be made available as additional modules.


Widgets:

This key is an array of objects, wherein each object includes details of the widgets created for the extension. An extension can have more than one widget with a set of properties. To know more about widgets, click here.

Copied//Normal Widget

"modules": {
    "widgets": [
      {
        "location": "desk.ticket.detail.rightpanel",
        "url": "/app/widget2.html",
        "name": "Desk Extension",
        "logo": "/app/img/logo.png",
        "icon": "/app/img/icon.png"
      }
    ]
  },
//Multi DC Widget

"modules": {
  "widgets": [
    {
      "name": "Desk Extension",
      "icon": "/app/img/icon.png",
      "logo": "/app/img/logo.png",
      "location": "desk.ticket.detail.rightpanel",
      "url": "https://desk.zoho.com/",
      "other_dc_urls": {
	        "EU": "https://european-union.europa.eu/index_en",
	        "IN": "https://www.india.gov.in/",
	        "AU": "https://www.australia.gov.au/",
	        "CN": "https://www.gov.cn/english/"
      }
    },
  ]
}

Show full

Show less

 

CSP Domains

This key defines the list of sites from which you want to load third-party assets such as JavaScript, CSS, and so on. If you need to load any third-party scripts, CSS, or other files (Other than ZOHO), you need to add them to the 'connect-src' list.

Copied"cspDomains": {
    "connect-src": [""]
  },
 

Connectors 

Connectors are arrays of objects that facilitate the seamless integration of extensions with third-party services. In these integrations, Zoho Desk typically handles the authorization of the third-party services. As a developer, you simply need to add the necessary functionalities for the integration by following the provided guidelines. Zoho Desk handles the authorization of third-party services listed in the connectors page. For detailed instructions on how to configure connectors, please refer to the 'Configuring Connectors' section.

Copied"connectors": [
    {
      "connectionLinkName": "wcconnection",
      "connectionName": "wcconnection",
      "serviceName": "woocommerce",
      "userAccess": true,
      "isUserDefinedService": false,
      "sharedBy": "1234567"
      "scope": " "
    }
  ]
 

Zoho Authorisation

ZohoAuthorization helps seamlessly integrate extensions with Zoho services. 'zohoAuthorization' is a JSON object that facilitates the integration of extensions with Zoho services. In these integrations, Zoho Desk typically handles the authorization of Zoho services.

You only need to add the required functionalities for the integration by following the provided guidelines.

➤ First, configure zohoAuthorisation by Creating a Zoho service connection by following the steps in the Sigma Connections Guide.

➤ On the Connection Summary page, under the JSON tab, copy the JSON data of the connection and use it in the zohoAuthorisation key.

Note: Since zohoAuthorisation is handled under Sigma connections, you must add an extra key called type with the value connectors inside the zohoAuthorisation key.

 

Copied"zohoAuthorisation": {
    "type": "connectors",
    "connectionLinkName": "zohodesk",
    "connectionName": "zohodesk",
    "serviceName": "zlabs_integration",
    "userAccess": true,
    "isUserDefinedService": false,
    "sharedBy": "1234567",
    "scope": [
      "Desk.tickets.ALL"
    ]
 

Config

The 'configParams' key defines the installation parameters, also known as config params, to be configured during the installation of the extension. For more information on config params, please refer to the 'Config Params' section.

Copied"config": [{
   "displayName":"API Key",
   "name": "apikey",
  "secure": true,
  "type":"text",
  "description": "To get the api key [visit here](https://test.requestcatcher.com)",
  "mandatory": true,
   "userdefined": true,
   "authType" : "org" 
    }]
 

Module Support

When moduleSupport is enabled, the CLI will generate a basic React app template for you. Additionally, JavaScript module support will be included and enabled. Since the code is organized into different modules, we will use webpack to bundle the extension."

By using webpack as a module bundler, it allows you to combine and package the various modules of your extension into a single bundle file. Also, helps you optimize the loading and execution of your extension code, ensuring that all the required modules are included and available for the extension to function properly.

Copied"moduleSupport": true
 

Update Before

This key defines a timeframe for updating an extension. It will display a message that the extension will be deprecated (even though it will not actually be deprecated) in the extension list view. Additionally, it sends an email to the installed users, covering both the content of the email (update availability and deprecation notice).The purpose of this key is to force the user to update the extension to the latest version.

The date must be provided in the ISO format, which follows a specific pattern for representing dates and times, as given in example.

Copied"updateBefore": "2024-01-15T04:49:09.963Z"
 

Secret

The secret is a passphrase that helps generate a hash for the invoke API.

Copied"secret":"mysecretkey"