Zoho Recruit | Custom Functions

Custom Functions

Zoho Recruit Custom functions help you to update data in related Recruit modules or third-party applications by executing simple program scripts. When a record matches the workflow criteria, workflow engine automatically triggers the custom function and updates the Recruit records. With custom functions, you can program scripts using Deluge Script (powered by Zoho Creator), associate them with workflow rules, and automate the recruitment process. See Also Deluge Script - Reference Guide.

Business Scenario

Candidate screening is a time-consuming process. In order to simplify, you can create a custom function with Zoho Recruit. By doing this, the recruiter can prioritise their follow-ups and other engagements with candidates.

Ideal Users

  1. Recruit Administrators who set up workflow rules for Users
  2. Programmers with REST API and Deluge Script skills


Profile Permission Required: Users with the Manage Workflow permission can access this feature.

Set Up Custom Functions

You can set up custom functions in three steps:
  1. Create a custom function.
  2. Associate custom function to a workflow rule.
  3. Test custom functions integration.
To create a custom function
  1. Go to Setup > Automation > Actions > Custom Function.
  2. In the Workflow Custom Functions page, click Configure Custom Function.
  3. Select a function from Gallery, existing function or write a new one using Deluge Script.

  4. Click Save.
To associate custom function to a workflow rule
  1. Click Setup > Automation > Actions > Rules.
  2. In the Workflow Rules page, click the Create Rule.
  3. In the Create New Rule tab, specify workflow rule parameters.
  4. Select Custom Function, under Instant Actions.
  5. Now select the custom function to be triggered.
  6. Click Save.
To test the custom function integration
  1. Add test data in Zoho Recruit according to your workflow rule criteria.
  2. Check for the data received from Zoho Recruit via custom function, in your application.
  3. Modify your custom function code in Zoho Recruit, if data is not received or if there is a data mismatch.
  4. Continue this test until you obtain the required data from Zoho Recruit to your Application.

Important Notes

  1. You can associate up to 6 (1 Instant Action and 5 Time-Based Actions) custom functions per workflow rule.
  2. You can execute only 5000 lines (Statements) in a single custom function call.
  3. You can transfer data for a maximum of 10 Recruit fields from Zoho Recruit to third-party applications using custom function.
  4. You can retrieve data from other Apps to Zoho Recruit using custom function.
  5. You must update the API ticket regularly according to limits in third-party applications.
  6. You will not receive any email notification, if the custom function integration stopped functioning due to any issue in a third-party API.
  7. If there is any failure while connecting to Zoho Creator service, custom function will send the second notification after 15 min. Thereafter, the system will not send any notifications for that particular workflow trigger. Errors returned from Zoho Creator are shown under Reason for Failures section.
  8. If you exceed the maximum count per day, the system will not send remaining custom function notifications to third-party applications and will notify the failure to Administrator. 
  9. Zoho Recruit will the send the data in following standard format for Date and Date-Time fields to third-party applications:
    1. Date: yyyy-MM-dd
    2. Date-Time: yyyy-MM-dd hh:mm
  10. Limits for Custom Functions:
    1. Calls per Month - 200000 calls
    2. Integration Tasks - 25000 Zoho API calls /day using deluge.
    3. Invoke URL API - 500 calls/day
    4. Send Email - 1500 emails/day

Business Scenario

Candidate Screening Summary:

Candidates can be screened according to the custom set criteria. By mapping the arguments of the custom function to rank the candidates. We have taken the Phone number, E-mail address, Job title, Skill set and industry details of the candidates to rank them. 
  1. id: Choose "Candidate Id" column from the list of fields. 
  2. phone: Choose "Phone" column from the list of fields. 
  3. email: Choose "Email" column from the list of fields. 
  4. title: Choose "Job Title" column from the list of fields. 
  5. skillset: Choose "Skill set" column from the list of fields. 
  6. resume: Choose "Is Attachment Present" column from the list of fields. 
  7. authtoken: (Custom Value) Provide the authentication token required to access your Zoho Recruit account using an API call
Candidate status like: Junk Candidate, Unqualified, Rejected, Waiting for Evaluation will be assigned when the given set of criteria is met.
Deluge Script for the above-mentioned scenario

if (phone.length() == 0 && email.length() == 0 && title.length() == 0 && skillSet.length() == 0 && resume == "false") {
    status = "Junk Candidate";
} else if (phone.length() == 0 || email.length() == 0) {
    status = "Unqualified";
} else if (title.length() == 0 && skillSet.length() == 0 || resume == "false") {
    status = "Rejected";
} else {
    status = "Waiting-for-Evaluation";
updateMap = Map();
updateMap.put("candidateStatus", status);
updateMap.put("authtoken", authtoken);
updateMap.put("candidateIds", id.toString());
updateMap.put("scope", "recruitapi");
updateMap.put("version", "2");
response = postUrl("http://recruit.zoho.com/recruit/private/json/Candidates/changeStatus%22,updateMap);
To configure this custom function;
  1. Log in to Zoho Recruit.
  2. Setup > Automation > Actions > Rules > Create Rule.
    You can create a new rule by specifying Module and Rule Name.
  3. Click Next.
  4. Choose when you want to execute this rule. Now select Create or Edit option under execute based on a record action.
  5. Click Next.
  6. Choose to which records you want to execute the rule. Select Records Matching the condition option and set the criteria.
  7. Click Next.
  8. Now choose Custom Function as Instant action.
  9. In the Call Custom Function pop-up, Click on +New Deluge to create or add Custom function.
  10. Click on the Gallery to use the pre-defined Custom Function.

  11. Click on Configure given against the Custom Function name- Screen Candidates.
  12. Edit the Title, Description and Deluge Script as per your requirements.

  13. Click on Edit Parameters and map the arguments by choosing from the dropdown list.

  14. Click on Save.
  15. As you finish editing your function, click on Save Script before saving the function.
  16. Click Save and Proceed and you will be taken to the Workflow page with Custom function added to the flow you have created.
  17. The Custom Function created will be run when you create or edit any candidate record.

Error Codes

When the execution of custom function fails, one of the following error messages will be displayed in Zoho Recruit:

HTTP Status Codes

  1. 400 Bad Request - Often missing a required parameter.
  2. 401 Unauthorized - No valid API key provided.
  3. 402 Request Failed - Parameters were valid but request failed.
  4. 404 Not Found - The requested item doesn't exist.
  5. 500, 502, 503, 504 Server errors - Error in the third-party application.
  6. Error Code 1 - Temporarily not able to connect to the API server. Check API server logs, firewalls settings for requests sent from Recruit.

Custom Errors

  1. Internal process failure - When the custom function is not executed due to errors in processing of the script.
  2. Day limit reached - When the company has reached the maximum limit for the day.
  3. Deluge Script - When the execution of workflow triggers fail due to errors in Deluge Script.

    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 CRM Training
      Redefine the way you work
      with Zoho Workplace

        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 CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now

            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION

                                    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.

                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series

                                          • Digest

                                          • Functions

                                          • Meetups

                                          • Kbase

                                          • Resources

                                          • Glossary

                                          • Desk Marketplace

                                          • MVP Corner

                                          • Word of the Day

                                            Zoho Marketing Automation

                                              Zoho Sheet Resources


                                                  Zoho Forms Resources

                                                    Secure your business
                                                    communication with Zoho Mail

                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times

                                                      Carry your calendar with you
                                                      Anytime, anywhere

                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now

                                                                      Zoho TeamInbox Resources

                                                                              Zoho DataPrep Resources

                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW

                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now

                                                                                                      • Related Articles

                                                                                                      • Custom Functions

                                                                                                        Custom functions help in automation where procedural logic is required, which cannot be implemented with the default actions such as, Tasks, Webhooks, etc. With custom functions you can automatically update the data in the related Zoho Recruit ...
                                                                                                      • Working with Custom Functions

                                                                                                        In today's fast-paced recruitment landscape, organizations often grapple with manual and time-consuming tasks that hinder efficiency and productivity. Tracking candidates, managing interview schedules, and maintaining data accuracy can become ...
                                                                                                      • Formula Field Functions

                                                                                                        Function performs a specific operation on values that you specify and generates a new value. To compose a function, you need to type the function name, followed by a set of parentheses(). The Zoho Recruit formula type custom field supports four ...
                                                                                                      • Custom Schedules

                                                                                                        Schedules are automated user-defined actions, which can be performed through custom functions either at a particular time or on a recurring basis. You can now schedule a custom function to be executed automatically on a daily, weekly, or ...
                                                                                                      • Custom Buttons

                                                                                                        Zoho Recruit offers standard buttons that execute predefined actions. For example, Associate to Job Openings is a standard button used to link a Candidate to a Job Opening, Clone is another standard button that is used to clone any record within your ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace



                                                                                                          Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.


                                                                                                          Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.


                                                                                                          Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.

                                                                                                          CRM Tips

                                                                                                          Make the most of Zoho CRM with these useful tips.

                                                                                                            Zoho Show Resources