Integrate with an onboarding tool
In this section you will find information on how to start using some Core HR apis on pre hired candidates.
How do I integrate an onboarding tool
The integration between an onboarding tool and a core HR system during the pre-boarding phase is a process that ensures a seamless transition for new hires. Through the use of APIs, the onboarding tool can communicate and exchange data with our core HR. This allows for the automatic transfer of employee information, reducing the need for manual data entry and the potential for errors. During pre-boarding, new hires are not fully employee and all data are stored in an object called "onboardes".
The onboardee is created or updated in Core HR
In this situation you want to create, from your external system, an onboardee file for a pre hired candidate. For this you will use the Create Onboardee api :
Creation:
Try out our Postman collection, that contains examples, dataset by dataset:
Update:
As soon as the onboardee file is created you will be able to "on-board" the candidate and transform him into an employee of the company.
You are able also to update it through the "patch" api :
A typical situation would be : update the email, with an email definition coming from the IT department, but beside this particular case, you have many fields that you can update through api.
All references apis are available here: https://developers.cegid.com/api-details#api=cegid-talentsoft-hub&operation=Onboardees_CreateOnboardee
The onboardees go to a payroll system
In this situation you will retrieve all onboardees, by using the api GetOnboardees.
Try out in Postman :