Command Palette

Search for a command to run...

Part III · Zoho Creator · Chapter 11

Widgets and JS API

311 words · preserved verbatim from the master reference

11.1 Widgets

Widgets are packaged mini-applications built with HTML, CSS, and JavaScript, bundled as a ZIP archive and uploaded to Creator. They can be embedded in page elements (the "Widgets" element type in Pages). Widgets extend Creator's UI beyond its built-in components: organizations can embed third-party libraries, build custom data visualizations, create interactive maps, or integrate specialized UI patterns.

As of February 18, 2026, the widget limit was increased from 50 to 200 widgets per account (February 2026 Release Notes). Widgets are available on paid plans only.

Widget CDN URLs were updated March 24, 2026:

  • V1: https://static.zohocdn.com/creator/widgets/version/1.0/widgetsdk-min.js
  • V2: https://static.zohocdn.com/creator/widgets/version/2.0/widgetsdk-min.js

Old URLs will be discontinued by June 2026 (March 2026 Release Notes).

11.2 JS API

Zoho Creator provides two versions of a JavaScript API for use within widgets (JS API for Widgets):

  • JS API V1: Based on REST API V2. Requires SDK initialization via ZOHO.CREATOR.init().
  • JS API V2 (recommended): Based on REST API V2.1. No initialization call required.

Available JS API V2 task categories:

CategoryTasks
Data APIsAdd Records, Get Record by ID, Get Records, Get Record Count, Update Record by ID, Update Records, Delete Record by ID, Delete Records
Publish APIsAdd Records, Get Record by ID, Get Records (for published components)
File APIsUpload File, Read File
Meta APIsGet Fields, Get Forms, Get Reports, Get Pages, Get Sections, Get Applications, Get Applications by Workspace
Util APIsSet Image Data, Navigate Parent URL, Get Init Params, Get Query Params, Get Widget Params
Custom APIInvoke Custom API (any custom API defined in Microservices)

Widgets running JS API tasks operate within the permission context of the user accessing them; API success depends on the user's configured permissions in the target application.