Zoho Recruit

Zoho Recruit¶

The Zoho Recruit modules allow you to monitor, create, update, send, retrieve, and list the records in your Zoho Recruit account.

Prerequisites

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

1. Go to Ibexa Connect and open the Zoho Recruit module's Create a connection dialog.
In the Connection name field, enter a name for the connection and click Continue.
Confirm the access by clicking the Accept button.

The connection has been established.

Triggers when a new record has been added.


Module	Select or map the modules for which you want to watch the new record. For example, candidates.
Limit	Set the maximum number of new records Ibexa Connect should return during one execution cycle.

Triggers when a record has been updated.


Module	Select or map the modules for which you want to watch the new record. For example, candidates.
Limit	Set the maximum number of updated records Ibexa Connect should return during one execution cycle.

Searches for records or lists them all.


Module	Select or map the modules for which you want to watch the new record. For example, `candidates`.
Sort Column	Select or map the column name to sort the records. For example, `Country`.
Sort Order	Select or map the order to sort the records. For example, `Asc for Ascending order`.
Format	Select the format to display the records. For example, `exclude empty fields`.
Limit	Set the maximum number of records Ibexa Connect should return during one execution cycle.

Retrieves a single record specified by ID.


Module	Select or map the modules and then select the related ID whose details you want to retrieve.
Format	Select the format to display the output. For example, `exclude empty fields`.

Creates a new record.

Module	Select or map the modules and then enter the details in the dynamic fields that auto-populate based on your selection to create the record.
Workflow Trigger	Select whether you want to insert a trigger a workflow when creating the record. When you set a trigger, an alert will be sent whenever any updates were made to the record.
Duplicate Check	Select or map the action if the record you are creating already exists in the system: Throw an error if Duplicate Update if Duplicate
Format	Select the format to display the output. For example, `exclude empty fields`.

Updates a record.


Module	Select or map the module, then select the record you want to update and enter the details in the dynamic fields that auto-populate based on your selection.
Workflow Trigger	Select whether you want to insert a trigger a workflow when creating the record. When you set a trigger, an alert will be sent whenever any updates were made to the record.
Format	Select the format to display the output. For example, `exclude empty fields`.

Performs an arbitrary authorized API call.

URL	Enter a path relative to `https://recruit.zoho.comcom/recruit/private` For example: `/json/Candidates/getRecords` For the list of available endpoints, refer to the Zoho Recruit API Documentation.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

The following API call returns all the candidate records from your Zoho Recruit account:

URL:

/json/Candidates/getRecords

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > response > result > Candidates > row.

In our example, 3 records were returned: