Candidate onboarding to uKnowva HRMS via third party API in uKnowva

Background:

A number of our enterprise customers - i.e those who use uKnowva for HRMS, also use some other IT systems to manage their overall hiring process and onboard them. Some customers prefer ATS integration with uKnowva for work so that routine actions of managing candidates can be done inside their ATS workflow and once confirmed this integration will involve pulling data of the selected candidate and onboard them in the HRMS system with their auto- filled information.

The Workflow:

The integrated experience starts in Human Resources when a hiring manager creates a recruiting request or a vacancy. When the request is triggered, the ATS pulls the detail for the request to create a hiring project. Then it follows the recruiting pipeline to select and hire a candidate for the position(s). Lastly, the ATS completes the round-trip integration by sending the selected candidate’s record to Human Resources. The candidate record can then go through more on boarding authentications and workflows to create the employee record.

Enable User Configuration:

Prerequisites for users before utilizing candidate Onboarding via Third Party:

·One Job vacancy post should be available in the uKnowva portal. For more information, refer:https://docs.uknowva.com/how-to/hrms/186-how-to-post-and-edit-job-on-uknowva

· Community field for the drop-down list of field names should be predefined by the administrator.

· Unique API key should be generated by uKnowva Team and shared over email.

Once the above following perquisites are checked off, the administration can publish/enable “Candidate Onboarding” from Plugin Manager.

 

 

When You click on the Candidate Onboarding hyperlink. It pop-up a window with plugin details and configuration details:

 

There is a list of predefined Community fields, as stated in the prerequisite. If there are any additional community fields to be added by a third-party on boarding party. They can define its API fields in the configuration, with its description. For example, companies also prefer vaccination details, which are not part of common prerequisites (Refer to Annexure).

 

In the Name field: define the API field name that is unique.

 

You can add multiple community fields, as per the requirement, and define them in a system that can link to the third-party application for extracting information.

 

Developers can refer developers configuration on at the end .


 


Default Profile Fields

This is a default profile fields database for users.

 

 

 


 

Configuration for Developers

Candidate Creation on HRMS API

 

API End Point:

https://domain-name/api.php/recruitment/candidate_onboarding/createCandidate

 

Token: uKnowva will share the token on a private mail.

 

Basic Parameters: Parameters name is mandatory, the value required is optional

 

Parameters Name

Value Required

Api-Id

NO

Token

YES

 

Status Code Specification:

 

Code

Specification

200

Success

400

Bad request

406

Error while inserting records

 

Create Candidate Request:

 

 {

"name":"Ashwin",

"email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",

"number":"8962968800",

"category":"",

"salary_expectation":"200000",

"work_exp":"2",

"current_ctc":"180000",

"notice_period":"30",

"city":"Mumbai",

"current_city":"Indore",

"qualification":"BE(CSE)",

"education":"",

"cover_note":"Better Opportunity",

"source":"Facebook",

"skills":"Adobe Analytics,Web Developer",

"expected_date_of_joining":"2022-01-15",

"profile_fields":""

}

Create Candidate Response:

{

"success_response":"created successfully"

 

}

 

 

 

 

 

Was this Article helpful?