Recruit Help

Custom Functions

Zoho Recruit Custom functions help you to update the 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 update the Recruit records. With custom functions, you can program scripts using Deluge Script (powered by Zoho Creator), associate them to workflow rules, and automate the business process. See Also Deluge Script - Reference Guide .

 Business Scenarios

  • Roll up amount from each potential (status is closed won) to Total Revenue (custom field) to the related Account. If customer makes 10 payments, you can view the total revenue from Account page, instead of creating a report. Based on the total revenue generated from customer, you can grade them type A, type B, type C customers.
  • Create a project in Zoho Projects or any 3rd-party project management application when the potential is won and closed in Recruit. Also, view the project link under an Account or Potential record to monitor the progress of the project.
  • Automatically update the address information of contacts based on the mailing address of the parent account.
  • When the potential status is "closed won", push the potential, related contact and account details to Zoho Books or any 3rd-party accounting software. Once status of the invoice is changed to "paid" in accounting software, instantly update Potential record in Recruit.

 Target Audience

  • Recruit Administrators who set up workflow rules for Users
  • 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:

  • Create a custom function.
  • Associate custom function to a workflow rule.
  • Test custom functions integration.

To create a custom function

  1. Go to Setup > Automation > Workflow Automation > Custom Function.
  2. In the Workflow Custom Functions page, click the Configure Custom Function.
  3. In the Configure Custom Function page, select a function from Gallery, existing function or write a new one using Deluge Script.
    Custom Function
  4. Click Save.

 To associate custom function to a workflow rule

  1. Click Settings > Setup > Automation > Workflow Automation > 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.
    Custom Function

 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

  • You can associate up to 6 (1 Instant Action and 5 Time-Based Actions) custom functions per workflow rule.
  • You can execute only 5000 lines (Statements) in a single custom function call.
  • You can transfer data for a maximum of 10 Recruit fields from Zoho Recruit to third-party applications using custom function.
  • You can retrieve data from other Apps to Zoho Recruit using custom function.
  • You must update the API ticket regularly according to limits in third-party applications.
  • You will not receive any email notification, if the custom function integration stopped functioning due to any issue in a third-party API.
  • 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.
  • 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. 
  • Zoho Recruit will the send the data in following standard format for Date and Date Time fields to third-party applications:
    • Date: yyyy-MM-dd
    • Date Time: yyyy-MM-dd hh:mm
  • Limits for Custom Functions:
    • Calls per Day - 10000 calls/day or 200 calls per user license for the org. (whichever is lower)
    • Integration Tasks - 25000 Zoho API calls /day using deluge.
    • Get Data  - 25000 calls/day
    • Post Data  - 2 calls/day
    • Send Email - 1000 emails/day

 Business Scenario

Roll up the potential amount to parent account


Roll-up amount from each potential (status is closed won) to Total Revenue (custom field) to related Account. If customer buys 10 times, You can see the total revenue from Account page, instead of pulling a report. Based on the Revenue from customer, later you can grade them type A, type B, or type C customers.

To configure this custom function, follow these steps:

    1. Log in to Zoho Recruit.
    2. Open Settings > Setup > Automation > Workflow Automation > Rules > Create a workflow rule for the Potentials module.
    3. Click Next.
      Custom Function
    4. Choose when you want to execute this rule. Now select Create or Edit option under execute based on a record action.
      Custom Function
    5. Click Done.
    6. Choose to which records you want to execute the rule. Select Records Matcing the conditon option and set the criteria as "Stage contains closed won".
      Custom Function
    7. Click Done.
    8. Now choose Custom Function as Instant action.
      Custom Function
    9. In the Configure Custom Function pop-up, click the Gallery link.
    10. In the Gallery page, click Configure for Roll-up Potential Amount to Account function.
    11. Specify values for the arguments as mentioned below:
      • AccountId: Choose "AccountId" column from the list of fields.
      • SumUpField: Specify the field you have in accounts module for the summation.
      • Click "Specify custom value" link and type your field name.


    12. Save the configuration. This will now automatically update the sum of the revenue generated by all the potentials of an account in the account module.

 Refer Error Codes

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

 HTTP Status Codes

  • 400 Bad Request - Often missing a required parameter.
  • 401 Unauthorized - No valid API key provided.
  • 402 Request Failed - Parameters were valid but request failed.
  • 404 Not Found - The requested item doesn't exist.
  • 500, 502, 503, 504 Server errors - Error in the third-party application.
  • 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

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

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: