hibob.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your HiBob account to Kombo.
General Notes
- OAuth is supported and is required to list your app on the HiBob Marketplace. You can enable OAuth in the integration Settings tab by entering your HiBob Developer Portal credentials there.
- HiBob only returns employees that the connected service user’s permission group can access. If an employee visible in HiBob is missing in Kombo, check that the group’s access includes that employee and every lifecycle status (Hired, Employed, Terminated, Garden Leave, Leave, Parental Leave), then run a new sync.
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Work Locations
Work Locations
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address | |
| type |
Employees
Employees
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_number | |
| first_name | |
| last_name | |
| nationality | |
| display_full_name | |
| job_title | |
| work_email | |
| personal_email | |
| mobile_phone_number | |
| ssn | |
| gender | |
| ethnicity | |
| marital_status | |
| employment_status | |
| employment_type | |
| weekly_hours | |
| avatar | |
| work_location_id | |
| manager_id | |
| home_address | |
| bank_accounts | |
| date_of_birth | |
| start_date | |
| termination_date | |
| remote_created_at | |
| custom_fields | |
| integration_fields |
Absence Types
Absence Types
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| unit | |
| custom_fields | |
| integration_fields |
Absences
Absences
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| approver_id | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| start_time | |
| end_time | |
| amount | |
| unit | |
| status | |
| employee_note | |
| type_id | |
| remote_created_at |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| pay_rate | |
| pay_period | |
| pay_frequency | |
| employment_type | |
| pay_currency | |
| effective_date | |
| custom_fields | |
| integration_fields |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type |
Time Off Balances
Time Off Balances
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| type_id | |
| balance | |
| balance_unit | |
| used | |
| used_unit |
Employee Document Categories
Employee Document Categories
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create absence
Create absence
Specifying absence status might not work consistently for all absence types
| Input Field | Notes |
|---|---|
| employee_id | |
| absence_type_id | |
| status | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| employee_note |
Delete absence
Delete absence
| Input Field | Notes |
|---|---|
| absence_id |
Create employee
Create employee
HiBob requires a start date for the employee. If
start_date is not provided, we will use the current date. HiBob requires a work site for the employee. We use the first one we find in the system if location_id is not provided in the request body| Input Field | Notes |
|---|---|
| first_name | |
| last_name | |
| work_email | |
| gender | |
| job_title | |
| home_address.street_1 | |
| home_address.street_2 | |
| home_address.city | |
| home_address.state | |
| home_address.zip_code | |
| date_of_birth | |
| mobile_phone_number | |
| start_date | |
| location_id |
Create employee (v2)
Create employee (v2)
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| staffing_entity_id | |
| properties |
Add document to employee
Add document to employee
| Input Field | Notes |
|---|---|
| employee_id | |
| category_id | |
| document.name | |
| document.content_type | |
| document.data_url | |
| document.data |
| Feature | Notes |
|---|---|
| OAuth | |
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Per Field Tests | The individual field detection might be inconsistent |
| Delta Syncs | |
| Custom Field Explorer | |
| Employees | |
| Employments | |
| Absence Types | |
| Connection Guide | |
| Prerequisites | |
| Employment History | |
| Group Types | |
| DEPARTMENT | |
| COST_CENTER |
You can use the Regular API or the Hire API to create employees in HiBob. The Regular API creates employees directly in the system. With the Hire API, employees are created as new hires and need to be manually approved in HiBob’s dashboard.
- hire-api
- regular
text
required
First Name
The first name of the employee
Unified field:
The first name of the employee
Unified field:
first_nametext
required
Last Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_nametext
required
Private Email
The private email address of the employee
Unified field:
The private email address of the employee
Unified field:
private_emailobject
required
object
array
Documents
They will be uploaded to the employee’s “Confidential” folder in HiBob.
They will be uploaded to the employee’s “Confidential” folder in HiBob.
Show items
Show items
file
object
Custom fields
Show properties
Show properties
array
array
array
array
array
Some optional form fields are referencing the following data models:
- Employees
This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
text
required
First Name
The first name of the employee
Unified field:
The first name of the employee
Unified field:
first_nametext
required
Last Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_nametext
Full name
text
Display name
text
Middle name
text
Avatar URL
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
text
required
Private Email
The private email address of the employee
Unified field:
The private email address of the employee
Unified field:
private_emailsingle_select
ID
References
References
/v1/hris/employees?remote_model=employeenumber
Company id
text
Creation timestamp
text
Cover image URL
object
object
Payroll
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
text
NI number
object
Employment
Show properties
Show properties
date
Employment effective date
single_select
Employment contract
single_select
Employment type
text
Working pattern
single_select
Personal working pattern
number
Hours in days not worked
text
Site working pattern
text
Actual working pattern
multi_select
Holiday calendar ID
single_select
Salary pay type
single_select
FLSA code
number
FTE %
number
Weekly hours
object
number
Additional pension contribution
text
Tax code
text
Time since last salary change
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
Variable
Show properties
Show properties
object
object
object
Entitlement
Show properties
Show properties
object
Deduction
Show properties
Show properties
object
required
Work
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
date
Work effective date
number
Employee ID
single_select
Job title
date
required
Start Date
Start date of the employee. Also considered to be the hire date
Unified field:
Start date of the employee. Also considered to be the hire date
Unified field:
start_datedate
Work anniversary
date
Original start date
text
Accumulated tenure (duration)
number
Accumulated tenure (years)
text
Tenure (duration)
number
Tenure (years)
number
Work anniversary (years)
single_select
required
Site
The employee’s site.
The employee’s site.
multi_select
Site
single_select
Department
single_select
Change type
number
Manager’s ID
single_select
Manager
References
References
/v1/hris/employees?remote_model=employeesingle_select
Second level manager
References
References
/v1/hris/employees?remote_model=employeecheckbox
Is a manager
number
Number of direct reports
number
Number of direct and indirect reports
number
Tenure sum of previous lifecycle entries in days
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
text
Work mobile
text
Work phone
object
Employee
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
single_select
Buddy
References
References
/v1/hris/employees?remote_model=employeesingle_select
HRBP
References
References
/v1/hris/employees?remote_model=employeesingle_select
Payroll manager
References
References
/v1/hris/employees?remote_model=employeesingle_select
IT admin
References
References
/v1/hris/employees?remote_model=employeesingle_select
Org level
single_select
Disability status
multi_select
Veteran status
single_select
Legal sex
date
Recent leave start date
date
Recent leave end date
date
Last day of work
multi_select
Ethnicities
multi_select
Job
checkbox
Employee.has paid payslip
multi_select
Repaying student or postgraduate loan type
Field should be blank if not repaying student loans. If repaying a student loan but unsure of the plan type, select “Plan 1”.
Field should be blank if not repaying student loans. If repaying a student loan but unsure of the plan type, select “Plan 1”.
object
object
Address
Show properties
Show properties
text
Address line 1
text
Address line 2
text
Full address
text
City
text
Zip Post Postal code
single_select
Country
text
State Province Region
text
Site address line 1
text
Site address line 2
single_select
Site country
text
Site zip Post Postal code
text
Site city
text
Site state Province Region
date
Address effective date
object
Home
object
object
Employment
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
object
Personal contact
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
Emergency
Show properties
Show properties
text
Emergency contact’s first name
text
Emergency contact’s middle name
text
Emergency contact’s last name
single_select
Emergency contact relationship
text
Emergency contact’s phone number
text
Emergency contact’s mobile phone number
text
Emergency contact’s email
text
Emergency contact’s address
text
Emergency contact’s city of residence
text
Emergency contact’s post code
single_select
Emergency contact’s country of residence
object
Internal
Show properties
Show properties
single_select
State
date
Creation date
object
User data
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
Eeo
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
single_select
Ethnicity
single_select
Job category
object
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
object
People analytics
Show properties
Show properties
single_select
Kids risk indicator
single_select
Age risk indicator
single_select
Is manager risk indicator
single_select
Number of people with the same title risk indicator
single_select
Team size risk indicator
single_select
Years with current title risk indicator
single_select
Years with recent salary risk indicator
single_select
Manager tenure risk indicator
single_select
Number of direct reports risk indicator
single_select
Team recent turnover risk indicator
single_select
Timeoff frequency risk indicator
single_select
Tenure rank risk indicator
single_select
Recent manager change risk indicator
number
Number of ‘low risk’ indicators
number
Number of ‘some risk’ indicators
number
Number of ‘at risk’ indicators
Integration Variants
Current connector: HiBob For HiBob, we also offer the following other connector variants:
HiBob ATS
HiBob for the ATS category