hrworks.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your HR WORKS account to Kombo.
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 |
Employees
Employees
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_number | |
| first_name | |
| last_name | |
| job_title | |
| work_email | |
| personal_email | |
| mobile_phone_number | |
| ssn | |
| gender | |
| employment_status | |
| employment_type | |
| avatar | |
| work_location_id | |
| manager_id | |
| home_address | |
| date_of_birth | |
| start_date | |
| termination_date | |
| custom_fields | |
| integration_fields |
Absence Types
Absence Types
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| unit | |
| half_days_supported | |
| exact_times_supported |
Absences
Absences
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| amount | |
| unit | |
| status | |
| type_id |
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 |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type | |
| parent_id |
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
| Input Field | Notes |
|---|---|
| employee_id | |
| absence_type_id | |
| status | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| employee_note | |
| start_time | |
| end_time |
Delete absence
Delete absence
| Input Field | Notes |
|---|---|
| absence_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
The maximum file size allowed by HR Works’ API is 10MB
| Input Field | Notes |
|---|---|
| employee_id | |
| category_id | |
| document.name | |
| document.content_type | |
| document.data_url | |
| document.data |
| Feature | Notes |
|---|---|
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Custom Field Explorer | |
| Employees | |
| Connection Guide | |
| Prerequisites | |
| Create credentials | |
| Group Types | |
| DEPARTMENT | |
| COST_CENTER |
The behavior of this action depends on the creation method selected during setup. With “Onboarding”, an onboarding document is created that the new employee can complete. With “Direct”, the employee record is created directly in HR WORKS (requires a Person ID and Personnel Number).
- direct
- onboarding
Some required form fields are referencing the following data models:
- Groups
text
required
Person ID
The user/login ID for the new employee. Must be unique in HR WORKS.
The user/login ID for the new employee. Must be unique in HR WORKS.
text
required
Personnel Number
The personnel number for the new employee. Must be unique in HR WORKS.
The personnel number for the new employee. Must be unique in HR WORKS.
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_namedate
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_datesingle_select
required
Organization Unit
The organization unit the new employee will be assigned to.
References
The organization unit the new employee will be assigned to.
References
/v1/hris/groups?types=DEPARTMENTtext
Work Email
The business email address of the employee.
Unified field:
The business email address of the employee.
Unified field:
work_emailsingle_select
Gender
The gender of the employee
Unified field:
The gender of the employee
Unified field:
genderdate
Date of Birth
The employee’s date of birth
Unified field:
The employee’s date of birth
Unified field:
date_of_birthtext
Nationality
The nationality of the new employee (three-letter country code, e.g. DEU).
Unified field:
The nationality of the new employee (three-letter country code, e.g. DEU).
Unified field:
nationalityobject
Address
Show properties
Show properties
text
Street 1
The street address of the employee
Unified field:
The street address of the employee
Unified field:
home_address.street_1text
Street Number
text
ZIP Code
The ZIP code of the employee
Unified field:
The ZIP code of the employee
Unified field:
home_address.zip_codetext
City
The city of the employee
Unified field:
The city of the employee
Unified field:
home_address.citytext
Country
The country of the address (three-letter country code, e.g. DEU).
Unified field:
The country of the address (three-letter country code, e.g. DEU).
Unified field:
home_address.countrySome required form fields are referencing the following data models:
- Groups
text
required
Private Email
The private email address of the employee
Unified field:
The private email address of the employee
Unified field:
private_emailtext
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_namedate
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_datesingle_select
required
Organization Unit
The organization unit the new employee will be assigned to. Determines the assigned country.
References
The organization unit the new employee will be assigned to. Determines the assigned country.
References
/v1/hris/groups?types=DEPARTMENTsingle_select
Gender
The gender of the employee
Unified field:
The gender of the employee
Unified field:
genderdate
Date of Birth
The employee’s date of birth
Unified field:
The employee’s date of birth
Unified field:
date_of_birthtext
Nationality
The nationality of the new employee (three-letter country code, e.g. DEU).
Unified field:
The nationality of the new employee (three-letter country code, e.g. DEU).
Unified field:
nationalitysingle_select
Marital Status
object
Address
Show properties
Show properties
text
Street 1
The street address of the employee
Unified field:
The street address of the employee
Unified field:
home_address.street_1text
Street Number
text
ZIP Code
The ZIP code of the employee
Unified field:
The ZIP code of the employee
Unified field:
home_address.zip_codetext
City
The city of the employee
Unified field:
The city of the employee
Unified field:
home_address.citytext
Country
The country of the address (three-letter country code, e.g. DEU).
Unified field:
The country of the address (three-letter country code, e.g. DEU).
Unified field:
home_address.countrysingle_select
Language
Determines the GUI language of the onboarding tool. Defaults to the language of the assigned organization unit.
Determines the GUI language of the onboarding tool. Defaults to the language of the assigned organization unit.
Integration Variants
Current connector: HR WORKS For HR WORKS, we also offer the following other connector variants:
HR WORKS ATS
HR WORKS for the ATS category