Custom Buttons

Customization is the most powerful way to build a flexible Applicant Tracking System. In Zoho Recruit, you can customize modules, fields, pages, links, and a lot of other elements. In addition to these elements, Zoho Recruit now allows you to create new button actions with the help of an advanced feature called Custom Buttons.

Custom Buttons in Zoho Recruit can be used to connect your ATS with third party applications, connect different Zoho Recruit modules or connect with other Zoho applications.


To Create a Custom Button:

  1. Go to Setup > Customization > Buttons.
  2. In the Buttons page, click CreateNewButton.
  3. In the CreateNewButton page, do the following:
    • Choose the module for which you wish to create the new button.
    • Enter the name of the button.
      Button name should not exceed 30 characters.
    • Click the Add Description link and specify the details of your custom button.
      The description should not exceed 250 characters.
    • Choose the location of your custom button from the drop-down list.
      Custom buttons can be placed in 4 different places in your Recruit account - Create/Clone page, Edit page, View page and next to each record in the list view.
      Note that you can add a maximum of 2 buttons in each of these locations.
    • Choose an action to be executed when a user clicks the custom button.
      You can either choose a predefined action from the gallery or an existing action that was already created by users in your organization. You can also define your own action by writing a custom function or invoking a URL based on your needs.
      It is mandatory to choose the button action.
  4. Click Save.
    Once the custom button is associated with an action, Recruit Administrators can manage permissions by assigning only specific profiles to view and access the custom button.

Note: You are allowed to create only two custom buttons in each location for each module in Zoho Recruit.

1. Choose your button action from gallery.

Zoho Recruit offers you a few ready-to-deploy button actions in the gallery, which can be associated with a custom button for different business scenarios whenever required.
Consider the following scenerio:

ScreenCandidates: For example, you may want to screen your candidates. Create a custom button to automatically screen a selected candidate.

To associate Gallery function with a custom button:

  1. Create a custom button and choose your button action as From Gallery from the drop-down list.
    Ready to use actions will be listed in the gallery.
  2. Click Configure for the corresponding action that you want to use.
    For example: Screen Candidates.
  3. In the ConfigureCustomFunction dialog box, specify the function name and  values for the Argument mapping using the EditParametersbutton and click Save.
    For example:
    • id: Choose "Candidate Id" column from the list of fields.
    • phone: Choose "Phone" column from the list of fields.
    • email: Choose "Email" column from the list of fields.
    • title: Choose "Current Job Title" column from the list of fields.
    • skillSet: Choose "Skill set" column from the list of fields.
    • resume: Choose "Is Attachment Present" column from the list of fields.
    • authtoken: (Click specific value) Provide the authentication token required to access your Zoho Recruit account using an API call.
  4. Select the profiles to which you want to provide access to this newly created button.
  5. Click Save.
    Your custom button will be created successfully.
    For example: In the Candidates module, whenever a user clicks the button "Screen Candidate" in the record details page, the particular candidate will be screened and an appropriate candidate status will be applied.

2. Choose your button action from existing action.

Existing actions are predefined button actions created by users in your organization. This option will be available only when you have already created custom functions for custom buttons in your Zoho Recruit account. These actions can be reused with different custom buttons whenever required.


3. Define your own button action.

You can define your own button action in two ways:

  • Writing your own custom function; or
  • Invoking a URL.

Write your own Custom Function:

Using our Deluge Script Editor, you can start defining your own button action by writing a new custom function. See Also Deluge Script - Reference Guide.

To write your own custom function:

  1. Create a custom button and choose your button action as WritingCustomFunction from the drop-down list.
  2. In the DelugeScript page, do the following:
    • Specify your FunctionName and click the EditParameters button.
    • In the EditParameters box, specify the argument name and map the argument with field name or specify custom value in Recruit module.
    • Click Done.
  3. Write your required function in Deluge Script Editor.
  4. Click SaveScript to validate your code.
    If there are no errors, your script is ready to associate with the custom button.
  5. Click Save.

The script will be associated with the custom button. Choose different user profiles to check who can access the custom button and click Save in the CreateYourButton page. Whenever you click on the custom button, the associated function will be triggered and the required action will be performed in one click.

Response Tracking:

A pop-up notification is shown whenever you click on the custom button. It indicates whether the custom function was executed successfully or not. If the function was executed successfully, the user messages are shown as the result. The user messages should be configured while writing the custom function using  "info" statements in Deluge Editor. Whereas if the function execution had failed, the error message is displayed along with the line number.

Custom Functions Limits:

The overall custom functions usage limits is shown below. This limit is applicable for the custom functions used for workflow automation and custom buttons.
Integration Tasks - 500 Zoho API calls/day using deluge. 

Get Data - 500 calls/day
Post Data - 500 calls/day

Note: Workflow rules can also be triggered through the custom function executed from custom button by using the Recruit API integration tasks inside Deluge Scripting.

Invoke a URL:

Using Invoke a URL, you can open a URL in a click of a button. This will open a desired action either on a new window, on the existing window itself or on a new tab.

Here is an example that shows how you can invoke a URL using a custom button.

Visit Current Employer profiles of your Candidates in Zoho Recruit: All the candidates in your account can have a field where you specify their Current Employer. By creating a URL that is associated with a particular company, you can directly go to the candidate's current employer's profile by just clicking the custom button (This custom button can be placed while creating, cloning or viewing a record based on your requirements).
For example: The link can be:${Candidates.Current Employer}

Note: The content of the URL can be dynamic and you can merge the URL with module fields.

To invoke a URL:

  1. Create a custom button and choose your button action as InvokingaURL from the drop-down list.
  2. Enter the value to construct the URL.
    The URL length should not exceed 3000 characters.
  3. Select the Fields from the drop-down list. This will insert the field variable as part of the URL.
  4. Choose where you want to show the button action.
  5. Select the profile to which the custom button needs to be accessible.
  6. Click Save.



You can edit the existing custom buttons whenever required. Only the Administrator of the Zoho Recruit account can edit the custom buttons.

To edit a custom button:

  1. Click Setup > Customization > Buttons.
  2. The list of all custom buttons for the all modules are displayed. You can choose to filter the custom buttons associated with a specific module.
  3. Choose the required button that you want to edit and click the Edit icon.
  4. In the EditYourButton page, edit the button name, button action, etc. as per your requirements.



Zoho Recruit Administrator can delete the custom button anytime.

To delete a custom button:

  1. Go to Setup > Customization > Buttons.
  2. The list of all custom buttons for the all modules are displayed. You can choose to filter the custom buttons associated with a specific module.
  3. Choose the required button that you want to delete and click the Delete icon.