Try this API
Call this method on live data to see the API request and response. Need help with the API Explorer?
You have invalid or missing required parameter values above.
Orchestly supports a variety of businesses. That said, every organization has a unique requirement. To enable users develop custom solutions for their business, we support user extensions. Developers can build their extensions and host them on Zoho Marketplace.
This is a handbook to build your own extension for Orchestly.
Orchestly uses ZET(Zoho Extension Toolkit) framework to build extensions that let you add new features and integrations to the product.
ZET framework allows your extension to interact with the product using supported JS SDK APIs. To facilitate this interaction, you can import the framework's JS file using the following command,
Once the JS is imported, the global object OrchestlySDK will be available. You can create a client object to communicate with the product using the below method.
To set up a run time environment for building the extension, install node JS and ZET CLI (Command Line Interface), both of which help in streamlining the development process.
Internal and external hosting
You can build your extension using client-side technologies like HTML, CSS, JS, etc. These extensions are then rendered in the product using iframes. Such extensions, built using client-side technologies, can be internally hosted using Orchestly's server.
However, if you wish to opt for server-side technologies, the extension must be externally hosted on a remote server.
While mentioning widget URL in the plugin-manifest.json file, internally hosted extensions are configured with a relative URL, whereas externally hosted extensions take up an absolute URL to which the extension points.
Public and private extensions
You can choose the audience for your extensions.
Public extensions are hosted on Zoho Marketplace for other users to install and use. A public extension must be submitted for review where the extension's functionality is tested. If the extension suits the standards of Zoho Marketplace, it gets listed for public users to install and use.
Private extensions have a restricted set of audience. If you wish to share the extension only within your organization, you can classify the extension as private. Private extensions do not go through a review process. Any user who has the extension's URL can install and use it.
How to create an extension?
Step 1: Install the node and ZET CLI
Start building your extension by setting up a run time environment.
sudo: npm install -g zoho-extension-toolkit
system: npm install -g zoho-extension-toolkit
zet -v (or) zet -version
zet -h (or) zet -help
Step 2: Build the extension
In the terminal window, navigate to the directory under which you want to build the extension.
A project template directory comprising all the necessary folders, dependency node packages, and files is created.
Next, execute cd[extension name], to navigate to the current path of extension's directory.
You can find this file in the extension directory. It contains meta information about the extension. Developers can configure information such as widget details, widget locations, connectors etc. Get a detailed insights of the file here.
JS SDK helps the developers gain contextual details about different entities. You can use the JS SDK methods by importing OrchestlySDK to your widget app file.
Data storage in extensions
In Orchestly, extensions can be used to store data, where the properties of various entities can be stored against the extension itself. This helps the developers store key-value pairs of data against entities and extensions.
Step 3: Test the extension
Once your extension is developed, you can test it in your local machine.
Enabling the developer mode
Step 4: Validate the extension
Once the extension is tested, the next step is to validate it.
Once the validation proves successful, you can start packaging the extension files. If not, make the necessary changes and run the command again.
Step 5: Pack the extension
In the terminal, execute the following command
All the files of your project directory are not required while uploading the extension on Zoho Marketplace. Executing this command zips only the essential files and folders like app and plugin-manifest.json, providing a ready to upload zip file.