Configuring plugin-manifest.json

plugin-manifest.json

Here's a sample JSON descriptor file for your reference.

Now we'll see how to define the properties of this file.

type

Enter the type as "personal" to allow all the users to configure the extension and "org" to allow the admin to configure the extension.

Key	Type	Value
type	String	Accepted Values : personal, org

locale

The language the extension supports. Currently, we support the locale "en" (English) only.

Key	Type	Value
locale*	JSONArray	en

service

Name of the Zoho product for which the extension is created. Here, it is "PROJECTS".

Key	Type	Value
service*	String	PROJECTS

storage

If this setting is true, storage space will be allocated in the product for this extension. By default, the value will be false.

Key	Type	Value
storage*	Boolean	true false

whiteListedDomains

The domains specified in this array can be called from the extension. Calls to other domains, except the ones with which a connection is established, will not be handled from the extension. If your extension doesn't use any third-party service, then this array can be declared empty.

Key	Type	Value
whiteListedDomains*	Array

modules

Modules of the extension. We support widgets currently.

Key	Type	Value
modules	JSONObject	Example: "widgets":[{ "location":"task_tab", "name":"GDrive for Zoho Projects", "url":"/app/index.html", "countkey" : "extensionUniqueKey" }]

Key

Type

Value

modules

JSONObject

Example:

"widgets":[{
"location":"task_tab",
"name":"GDrive for Zoho Projects",
"url":"/app/index.html",
"countkey" : "extensionUniqueKey"
}]

widgets

This key holds an array of objects. Every object has three keys - 'location', 'name', and 'URL'.

Key	Type	Object Details
widgets	JSONArray	Key	Type	Description	Value
		location	String	Places where the extension has to be rendered in the product.	task_tab issue_tab milestone_tab project_tab app_settings top_band attachment_picker taskdetails_rightpanel issuedetails_rightpanel blueprint_during task_transition Note: The location name must be unique.
		name	String	The name of the widget.	Example: Checklist
		url	URL	The relative path of the file that loads the widget.	/app/index.html
		icon	String	The icon of the widget.	Icon is mandatory for attachment picker.
		countkey (available for task_tab, milestone_tab, and issue_tab)	String	Unique id to retrieve the widget count.	extensionUniqueKey

An extension can have multiple widgets.

Note: extensionUniqueKey is used to store/update the extension data.

connectors

Like widgets, this key also holds an array of objects. A connector helps to integrate an extension with a third-party service. Authorization of such third-party services is usually handled by Zoho Projects.

Key	Type	Object Details
connectors	JSONArray	Key	Type	Description	Value
		connectionLinkName	String	Link name generated for the third-party service connection	The value of the connectionLinkName param generated in the JSON tab of the connection summary. Note: The connection name must be unique.
		connectionName	String	Name of the connection	The value of the connectionName param generated in the JSON tab of the connection summary.
		serviceName	String	Name of the third-party service	The value of the serviceName param generated in the JSON tab of the connection summary.
		userAccess	Boolean	This parameter decides whether the extension has to be authorized by each user individually or it has to be authorized only by the admin.	true false
		isUserDefinedService	Boolean	Is the connection established with a custom service?	true false
		Scope	JSONArray	The access privilege set for the users/admins.	Example: ["https://www.googleapis.com/auth/drive.readonly"]

An extension can be connected to a maximum of 5 third-party services at once.

config

This key can be used when you have to get more inputs from the user to operate the extension. Say, you need the user's domain name of a third-party service for your extension to function. To fetch it, you can use this key to get input from the user accordingly.

Key	Type	Object Details
config	JSONArray	Key	Type	Description	Value
		name*	String	Name of the parameter.	The name should be unique.
		type*	String	The data type of the parameter	'text' 'password' 'checkbox' 'url' 'number' 'multiline' 'selectbox' 'hidden'
		default	String	The default value of the parameter	Note: This parameter is optional.
		options	JSON array	Options are mandatory if 'select box' is chosen as the type.	Example ["New feature", "Enhancement"]
		is_secure*	Boolean	Setting this to "true" prevents the developer from accessing this configuration from the extension.	true false
		is_mandatory	Boolean	Is the configuration mandatory?	true false
		description	String	A brief description of the configuration	Note: This parameter is optional.

Create. Review. Publish.

Write, edit, collaborate on, and publish documents to different content management platforms.

Get Started Now

Access your files securely from anywhere

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

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.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Retail	Online Data Collection Tool
Embeddable Forms	Banking	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
CRM Forms	Customer Service	Forms for Solopreneurs
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Forms for Enterprise
Contact Forms	E-commerce	Forms for any business
Lead Generation Forms	Healthcare	Forms for Startups
Wordpress Forms	Customer onboarding	Forms for Small Business
No Code Forms	Construction	RSVP tool for holidays
Free Forms	Travel	Features for Order Forms
Prefill Forms	Non-Profit	Forms for Government
Intake Forms	Legal	Mobile App
Form Designer	HR	Mobile Forms
Card Forms	Food	Offline Forms
Assign Forms	Photography	Mobile Forms Features
Translate Forms	Real Estate	Kiosk in Mobile Forms
Electronic Forms	Insurance
Drag & drop form builder
Notification Emails for Forms	Alternatives	Security & Compliance
Holiday Forms	Google Forms alternative	GDPR
Form to PDF	Jotform alternative	HIPAA Forms
Email Forms	Wufoo alternative	Encrypted Forms
Accessible Forms	Typeform alternative	Secure Forms
		WCAG

Quick Links

New to Zoho Writer?

Signup Now

Zoho Writer

What's new

Help Guide

Blogs

Forums

Webinars

API

Developers

Build Extensions

Create. Review. Publish.

Write, edit, collaborate on, and publish documents to different content management platforms.

Get Started Now

Zoho Campaigns Resources

Campaigns Community Learning Series

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

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?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

New to Zoho Desk?

Access Zoho Desk

What's New in Zoho Desk

Use cases

Make the most of Zoho Desk with the use cases.

Learn More

eBooks

Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

Download eBooks

Videos

Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

Watch Now

Webinar

What's New in Zoho Desk

Desk Community Learning Series
Meetups
Ask the Experts
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Configuring Connectors
Establish a connection for an available third-party service If your extension uses a third-party service, you need to configure a connector to establish a connection with the third-party service. You can connect to multiple third-party services at ...
Import from XLS/CSV/JSON/MPP
You can now import MPP/ MPX/ XLS/ JSON/ CSV files into Zoho Projects and start collaborating. Users can import 5000 tasks at a time. Login to Zoho Projects with Administrator privileges. Click in the upper-right corner of the top navigation band. ...
Widget Locations
List of widget locations in Zoho Projects Location An extension's widget can be rendered in multiple locations inside the product. This key (location) defines where the widgets should be rendered. Zoho Projects provides a list of widget locations. ...
Creating extension using CLI
Overview Zoho Marketplace is an online store where you can upload the extensions you develop for any of the products of Zoho. You can also use the available extensions in our store for your business. This developer guide will help you build an ...
Create extensions using cloud editor
Zoho Projects lets you build extensions using a cloud editor eliminating pre-setup and managing the entire development process online. Here is a webinar to help you navigate through the cloud editor. Overview Zoho Marketplace is an online store where ...