JS SDK Library
JS SDK URL to be included in your code before calling the following SDK methods:
To register listeners with widgets:
Use the following code snippet to initialize your widget and start listening to events in your Zoho People application.
ZOHO.embeddedApp.init();
Get form id
Supported only for Related list and custom button widgets.
To get form id where the widget is currently rendered, use:
ZOHO.People.API.getFormId()
Response
String(record id)
Get form field components
To get form field components, use:
Response
[{
"comptype": "Text",
"comptype": "Text",
"ismandatory": true,
"descriptionType": 0,
"displayname": "EmployeeID",
"autofillvalue": "",
"description": "",
"formcomponentid": "115782000000020183",
"labelname": "EmployeeID",
"maxLength": 100
}, {
"comptype": "Text",
"ismandatory": true,
"descriptionType": 0,
"displayname": "Last Name",
"autofillvalue": "",
"description": "",
"formcomponentid": "115782000000020187",
"labelname": "LastName",
"maxLength": 100
}]
Add form record
To add a form record, use:
ZOHO.People.API.addFormData(inputData);
inputData | JSON Input: {formName:<form name>, input:{LabelName:value, LabelName1:value}}; For LabelName - Refer here |
Response
Success Response: Data added successfully
Failure Response: Error occurred
Update form record
To update the form record, use:
ZOHO.People.API.updateFormData(inputData);
inputData | JSON Input: {formName:<form name>, input:{LabelName:value, LabelName1:value},recordId: <form record id>}; For formName - Refer here |
Response
Success Response: Data updated successfully
Failure Response: Error occurred
Get record id
Supported only for Related list and custom button widgets.
To get record id of the record in which the widget is currently rendered, use:
ZOHO.People.API.getRecord()
Get form data by record id
To get form data by record id use:
ZOHO.People.API.getFormRecord(inputData):
inputData | JSON Input: {recordId:<record id>,formName: <form name>}; For formName - Refer here |
Current form record id can be get from ZOHO.People.API.getRecord()
Response
{"LabelName": value, "LabelName1":value2,"LabelName_downloadUrl":file upload field download url}
Get bulk form records
To get bulk form records, use:
ZOHO.People.API.getBulkRecords(inputData)
inputData | JSON Input: {formName:<form name>,startIndex:<from limit>,limit:<to limit>} startIndex- not mandatory, default value -1 limit- not mandatory, default value - 200 |
Response
[{"LabelName": value, "LabelName1":value2,"LabelName_downloadUrl":file upload field download url}, {"LabelName": value1, "LabelName1":value22,"LabelName_downloadUrl":file upload field download url},
]
Get form data sectionalise
To get form data by section, use
ZOHO.People.API.getFormDatabySection(inputData)
| inputData | JSON Input: |
Response
[
{
{
"Section1": {
"Label name": value, "Label name": value
},
"Section2": {
"Label name": value, "Label name": value
},
"tabularSections": {
"Label name": [
{
"Label name": value, "Label name": value
}
],
"ApprovalStatus": "Approval Not Enabled"
}
]
Download form file
To download the form file, use:
ZOHO.People.API.downloadFormFile(inputData);
inputData | JSON Input: {fcId:<form component id>,recordId:<form record id>,formId:<form id>} |
Response
File Content
Get file categories
To get file categories, use:
ZOHO.People.API.getFileCategories();
Response
[{"CatID":"1","CatName":"Test"},{"CatID":"2","CatName":"Test1"}]
Upload employee files
To upload a file, use:
ZOHO.People.API.uploadEmployeeFile(fileInput);
fileInput | JSON Input: {uploadfile:<Blob or file>, fileName: <File name>, employeeId:<empId>,fileDesc: <Description>,catId:<CategoryId>}; To get catId, use: ZOHO.People.API.getFileCategories(); |
Response
Success Response: Data added successfully
Call third party APIs
To call third party APIs, use:
ZOHO.People.Http.post(requestObj);
inputData | JSON Input: var requestObj = { url : url, header: {'Authorization'':"Zoho-oauthtoken-__token"} params: {}; };  Zoho-oauth is for invoking Zoho Services api. |
Response
Response from the api.
Invoke API via Connections
To invoke API via Connections, use:
ZOHO.People.API.invokeUrl(requestData);
inputData | JSON Input var requestData = {url: <url to invoke>, connectiondetails:"name=<connection-name>", params : <url params>, // optional methodType: <GET|POSTPUT|DELETE>; extraParam={"Content-Type" : "application/json"};// optional }; |
Response
Response from the api.
Sample widget code
- <!DOCTYPE html>
- <html>
- <head>
- <meta charset="UTF-8">
- <script src="https://static.zohocdn.com/zp5/widgets/zpwidgetsdk.min.js"></script>
- <script>
- window.onload = function () {
- // initialize the widget, before invoking any js sdk method
- ZOHO.embeddedApp.init().then(function() {
- ZOHO.People.API.getRecord().then(function(record) {
- ZOHO.People.API.getFormRecord({formName:"employee",recordId:record}).then(function(recordData){
- console.log(recordData);
- });
- });
- });
- }
- </script>
- </head>
- <body>
- <h2>This is a sample widget to get form record.</h2>
- </body>
- </html>
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.
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.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Custom Widget - Introduction
What is a custom widget? Customize your Zoho People application user interface with custom widgets, which are embeddable user interface components that you can create and add to your Zoho People application. You can build widgets for Zoho People ...Web Tab in Zoho People
What is Web Tab in Zoho People? Web Tab in Zoho People allows loading external websites or custom web pages/web apps created using Zoho CLI and JS SDK. It works similarly to the Custom Widgets feature in Zoho People. Where can Web Tabs be deployed in ...Developer Space
What is the Developer Space in Zoho People? In Zoho People, Developer Space is a feature that allows developers to further extend the capabilities of the Zoho People HR platform. Access Zoho People configuration and data using secure APIs. Using the ...Create Widget Using Zet-CLI Tool
The Zoho Extension Toolkit (ZET) is a command-line interface designed to assist developers in creating and packaging widgets for integration with Zoho People. Prerequisites Download the nodejs source code from https://nodejs.org/en Use the following ...Custom Widget
Custom widgets are embeddable user interface components that you can create and add to your Zoho People application. Widgets can be used to extend the application's front-end capabilities according to your requirements. Use widgets to perform ...
New to Zoho LandingPage?
Zoho LandingPage Resources