Plugin Manifest Configuration

The file plugin-manifest.json in the widget directory holds the configuration details of widgets. Here’s how you can define the keys:

Locale

Locale is the language supported. Currently, Zoho Books supports only English (“en”).

Key	Type	Value
locale*	JSONArray	en

Service

Service is the product for which the widget is created. In this example, the product is Finance.

Key	Type	Value
service*	String	FINANCE

“location”: “invoice.detail.sidebar”,

Module

Currently, Zoho Books supports the widgets module.

Key	Type	Value
modules*	JSONObject	`"modules": { "widgets": [ { "name": "Zbooks Extension", "widget_type": "modal", "location": "invoice.detail.sidebar", "url": "/app/widget.html", "logo": "/app/images/app_icon.svg", "popup": { align: "top" } } ] }`

Details about the widgets will be captured here. It holds an array of objects. You can combine two or more widgets to create a new widget as well.

Key	Type	Object Details
widget	JSONArray	Key	Type	Description	Value
		name*	String	Name of the widget.
		location*	String	Location in the product where the widget has to be rendered.Note:The location must be unique.	invoice.list.sidebar invoice.details.sidebar invoice.creation.sidebar dashboard.widget background application.allpages.sidebar (Other supported locations)
		url*	URL	Path of the file that loads the widget.	For internally hosted widgets, mention a relative URL of the widget.For externally hosted widgets, mention the absolute URL of the widget.
		logo	URL	Logo of the widget.
		widget_type	String	open the widget as a pop instead of sidebar, also need to invoke resize sdk if widget is of type modal to set the popup size	modal

Locations

This key defines the different locations in Zoho Books where widgets can be positioned or rendered. Read our help document on Locations to learn more.

Run Widgets in the Background

You can run the widgets you’ve installed in Zoho Books in the background. When you run widgets in the background, they can receive and respond to API events from the from the location where you installed them.

 background

Used Connections

Third-party authentication and integration can prove to be challenging. To make authenticating easy, we support Connections. Connections is a built-in Zoho service used for authenticating third-party services using OAuth 2.0 protocol. You can easily establish a connection with a third-party service if the service has already been configured. You can find the list of available services by navigating to Zoho Books and then selecting Developer Space. From Connections, select Predefined Services. Learn how to add a custom connection.

Third-party authentication using connectors:

Widgets created for third-party services need a connector to establish a connection with Zoho Books. You can either connect to an available third-party service or request a new one.

To establish a connection with an available third-party service:

Create a new connection. The JSON script generated in the connections page will be used in the usedConnections key of the plugin-manifest.json file.

Key	Type	Object Details
usedConnections	JSONArray	Key	Type	Description	Value
		connectionLinkName	String	Link name generated for the third-party service connection	Enter the value of connectionLinkName generated as JSON while establishing the connection.
		connectionName	String	Name of the connection	Enter the value of connectionName generated as JSON while establishing the connection.
		serviceName	String	Name of the third-party service	Enter the value of serviceName generated as JSON while establishing the connection.
		UserDefinedService	Boolean	Is the connection established with a custom service?
		scope	JSONArray	Access privilege of the user/admin.
		userAccess	Boolean	Authorization can be performed, as a one time setup by the organization's administrator. As an individual setup by each user of the organization.	Mention 'False' if authorization has to be performed by administrator.Mention 'True' if authorization has to be performed by every user in the org.

cspDomains

You can mention the domains that needs to be added in the Content-Security-Policy header to control the resources that the widget is allowed to load.

Key	Type	Value
cspDomains	JSONObject	`[ { "connect-src": ["trusted.com"] } ]`

Was this document helpful?

Yes

Was this document helpful?

By clicking Submit, you agree to our Privacy Policy .

Thank you for your feedback!