Step 1: Extension Pre-requisites
Get access to Developer console
Before you start building your extension, first you’ll need to set up a Zoho Sigma account by visiting
If you are an existing Zoho customer, you can get access to the Developer Console by logging in using your Zoho credentials.
For new users, to get access to the Developer Console
- Go to https://sigma.zoho.com/ and enter your Workspace Name..
- Fill in the necessary details and click Create Workspace.
- You will receive an email with a confirmation link to your registered email address. Click that link and follow the steps provided to complete your registration.
Now you have a Zoho Developer account and you can begin the journey of your first extension creation.
Identify and prepare extension requirements:
Before you get started, it can be helpful to create a list of features that the extension is going to add in the Zoho Recruit. Not only will this help you strategize the best way to implement the extension, but it will also give you an idea of the steps you need to take before you begin the process of programming your extension. This preparation could include creating a custom field, setting up a custom module or building a webhook for a third-party service.
Step 2: Create your extension.
2.1 Set up your new extension
- Click the Extensions on the top left of the Zoho Sigma homepage.
- Click New Extension.
- In the New Extension page, Specify the Extension's name.
Once the name is specified, a Unique Namespace is automatically populated. Once created, the Namespace cannot be changed.
- Provide a short description for the extension.
- Select the service and click Save as Draft.You will be navigated to the Zoho Developers console.
2.2 Set up a workflow rule within the extension.
Workflow rules are a set of conditions that trigger specific actions within your application, such as sending email alerts, assigning tasks or updating the information in your records.
- Open the Workflow tab in the left-hand panel.
- Choose a name for the rule and give a brief description.
- Click Next.
2.3 Specify your rule trigger:
To set up a new rule, you must choose which type of execution trigger is associated with that rule. There are two types of rule triggers:
Record Action - trigger rule when records are created, edited, created/edited, deleted or a specific field is updated.
A Date Field's Value - for records matching rule criteria, trigger rule either monthly or yearly based on the value in the selected date field.
- Select A Record Action from the drop down menu.
- Click Create or Edit.
- Click Next.
2.4 Set Rule criteria:
- Select Execute workflow whenever the criteria is met.
- Set the criteria pattern
- Click Next.
2.5 Associating your Custom function to a workflow.
Custom functions allow you to use procedural logic to automate processes that are not covered by Zoho's default actions.
- Click on the Associate button at the bottom of the page.
- In the following screen, you'll be able to create your custom function using Zoho’s DELUGE script editor.
- Create a name of custom function and click Save and Close.
Step 3: Test your extension
Once you’ve finished building your extension, it’s time to test it. Zoho makes this easy by providing an isolated sandbox environment where you can test the extension without affecting the actual Zoho Recruit account in which it is going to be installed. Click Test your Extension at the top of the Extension Details page.
Step 4: Publish your extension
After successfully testing of the extension you can publish the extension.
Follow the steps:
- Open the Extension Details tab in the left-hand panel.
- Click Publish next to the name of the extension. A window will open displaying all the fields and custom function you have added.
- Review your extension, add remarks so that it becomes easier for us to review the extension and click Confirm.
- After you click Confirm, a popup window will appear, displaying the URL for your extension. To install the extension, navigate to the URL by copy the link to another browser window.
- If you would like to make your extension publicly available on the Zoho Marketplace, click the check box at the bottom of the popup window. Your extension will be submitted to our review team, and if accepted, other users will be able to install it on their Zoho Recruit systems.
- You may also share the extension via email. Click on Share Privately, enter an email address and click on Send. The email will contain the link to installing your extension.
By default, your extension will be private, meaning it will not be listed on the Zoho Marketplace. If you forget to save the URL, you can find it in the Extension Details page.
It is also possible to create an extension that integrates different third-party applications with Zoho Recruit, as different customers are in need of different integrations and this will help them achieve their requirements. These are the methods which we support to integrate the extensions with the third-party services :
- Token based authentication by using Custom Variables.
- OAuth 2.0 by using Connections.
You can now start building your extension