Plugin-manifest
The configuration details of each extension are stored in the plugin-manifest.json file in the extension project directory. The various keys included in this file are as follows:
- locale: Default locale for the extension. All translation files must be stored in the ".json" format, inside the translations folder of the extension's project folder; for example, en.json, fr.json, jp.json and so on.
- service: Name of the Zoho product for which this extension is created; for example, DESK, CRM, MAIL, and so on
- storage: Setting that enables or disables data storage for the extension. This feature is disabled by default.
- whiteListedDomains: Access to data from third-party services is made possible through request APIs provided by Zoho Desk. Only domains specified under the whiteListedDomains key are allowed to make API calls. Requests from domains that are not included under this key are not handled. If your extension does not include third-party service requests, this key is declared as an empty array.
- type: Extensions for third-party services integrate with Zoho Desk via connectors. Zoho Desk handles authorization for some third-party services, which are listed in the Sigma Connections page. End-user access to these extensions depends on the value you set for this key: org or personal.
- org: Extensions with this value for the type key can be viewed only by the Zoho Desk admin at first. Other users in the organization can access the extension only after the admin installs it on the portal and authorizes the user(s).
- personal: Extensions with this value for the type key can be viewed by all users of the portal except those with Light Agent profile. Authorization to use the extension does not rest with the admin in this case.
- modules: Modules of the extension. Currently, only widgets are available. In the future, buttons, menus, and tabs will also be made available.
- 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 as mentioned below.
- {
- “location” - Location of the widget. All locations are
- predefined and explained in this document,
- “url” - starting point of the widget. Can be either a
- relative path (for internally hosted extensions) or an
- absolute path (for externally hosted extensions),
- “name” - Name of the extension (displayed in the extension
- header),
- “logo” - Logo of the extension (displayed in the extension
- header),
- “icon” - Icon of the extension (displayed only on widgets on
- the chat bar and subtab)
- }
- Connectors:
- Connectors are arrays of objects that help seamlessly integrate extensions with third-party services. In these integrations, authorization of the third-party services is usually handled by Zoho Desk. As a developer, you just need to add the functionalities for the integration by adhering to the guidelines.
- Authorization of third-party services listed in the connectors page are taken care of by Zoho Desk. For services that are not listed, you must raise a request on the same page. A new connector for the service is then created and listed for use.
- For information on how to configure connectors, visit the Configuring Connectors section.
- Config: This key contains the installation parameters, better known as config variables, to be configured when installing the extension. There are two types of config variables:
- userdefined (type1) - value for the variable is provided by the user during installation
- {
- “name” : Name of the parameter which will be used to replace
- the values and displayed as a label
- “userdefined” : true (input value to be given by user),
- “type” : Input type (text field/drop-down) list/radio button);
- only text field is supported currently,
- “value” : Initial value of the parameter,
- “mandatory” : This property performs validation check when
- the user misses to enter values during installation,
- “secure” : true - values will be available only on the server
- side of the product; the client side will not have access to
- the values. false - values will be available on the client
- side0.
- }
- non-userdefined (type2) - value for the variable is set dynamically from the extension, via the Set value for extension config variables API
- {
- “name” : Name of the parameter which will be used to replace
- the values
- “value” : Value of the parameter
- }
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Request API
This API avoid CORS-related issues and successfully run third-party APIs from the extension. Request var reqObj= { url : 'http://demo2022863.mockable.io/test', headers : { 'Content-Type' : 'application/json' }, type : 'GET', ...Configuring Connectors
To configure a connector for a third-party service, perform the following steps: Visit the All Connections page on the Sigma site. Click Connections from side menu. The list of third-party services currently supported appears. Click the service you ...Quickstart to Zoho Desk Extensions
At Zoho Desk, we believe in delivering good user experiences and making already good experiences better. In that vein, stepping into Zoho Marketplace is an effort towards achieving the latter goal. Zoho Marketplace is an online store where users can ...Extension Webhook
Marketplace supports Extension Webhook , which will allow a market place app to create extension specific desk webhooks. Extension webhook access is restricted to the extension app alone so that the normal user can't make any changes on these ...Platform Event Callbacks
Marketplace supports callbacks for extension's events. Developer can subscribe to the supported events and when the extension event is triggered, callbacks are invoked. Supported Platform Event Callback's are, onInstall onZohoAuthorise onTPAAuthorise ...
New to Zoho LandingPage?
Zoho LandingPage Resources