This deployment guide specifically relates to the deployment of an integration whereby new hires are pushed from a recruitment platform (ATS) through to intelliHR. The article will stipulate the processes around pushing through a new person, creating a new job, the uploading of documents and triggering of workflows.
Navigation:
Creating a Person
In order to bring information about a new hire into intelliHR, you’ll need to first create a person record. The only required field for a person is lastName, but we recommend creating a person with a firstName, lastName and emailAddress.
💡 See “Creating People and Jobs” for a guide on creating people via the Public API.
Uploading Documents
Once you’ve created a person, you may want to send pre-employment documents to intelliHR like a copy of the new starter’s contract, resume and so on.
You’ll need to perform the upload process after you’ve created a person. The response from the person create endpoint will include an id. Use this id when preparing the presigned URL.
💡 “Uploading People Documents” via the Public API Guide coming soon.
Creating a Job
Now that both systems contain the same job attributes, you should perform a POST to Create a new Job. In order to create a job in intelliHR, you’ll need to provide a series of job attributes that match the existing attributes in intelliHR. You can find a list of required fields on the job here.
We recommend sourcing their attributes directly from our API, as each attribute has an associated list endpoint and means that shared clients will not need to manually maintain these attributes between systems.
For example, Business Unit is a required field.
You can retrieve a list of paginated Business Units from the List all Business Units endpoint and retrieve the more appropriate resource for the search object, either name or id (or other search keys) depending on the use-case.
Where possible we recommend sending id for as many search objects as possible as you are guaranteed to find a match, where a client may have two Business Units of the same name, which will cause the search to fail. The most successful integrations create a mapping between the Business Unit Name and id, allowing end-users to select a name while transmitting the id via the API request. This pattern should be repeated where possible on other attributes as well.
We recommend populating the drop-downs in your ATS by retrieving these lists at initialisation, on a regular basis and/or on page-load.
Triggering Workflows
intelliHR allows administrators to configure workflows attached to events, like create job.
Workflows are a series of forms (sent as forms) assigned to various people at different points in time as a result of an action or change in the system. The forms are sent in a specific order based on the day of the event with the subject person always being the person who's profile triggered the event, the respondent can vary.
Workflows can be retrieved and initiated via the Public API.
Once you have created a person and job, we recommend offering the ability to trigger workflows.
💡 See “Managing Workflows via the Public API” for more deployment information.