This connector is in open beta. You can freely enable it in your account.
ukgpro.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your UKG Pro account to Kombo.
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Legal Entities
Legal Entities
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address | |
| remote_data |
Work Locations
Work Locations
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address | |
| remote_data |
Employees
Employees
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_number | |
| first_name | |
| last_name | |
| nationality | |
| job_title | |
| work_email | |
| personal_email | |
| mobile_phone_number | |
| ssn | |
| gender | |
| ethnicity | |
| marital_status | |
| employment_status | |
| employment_type | |
| weekly_hours | |
| work_location_id | |
| legal_entity_id | |
| manager_id | |
| home_address | |
| bank_accounts | |
| date_of_birth | |
| start_date | |
| termination_date | |
| remote_created_at | |
| custom_fields | |
| integration_fields | |
| remote_data |
Absence Types
Absence Types
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| unit | |
| remote_data |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| pay_rate | |
| pay_period | |
| pay_frequency | |
| employment_type | |
| effective_date | |
| remote_data | |
| custom_fields | |
| integration_fields |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type | |
| remote_data |
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 | |
| remote_data |
Staffing entities
Staffing entities
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| model_type | |
| description | |
| status | |
| employment_types | |
| number_of_openings | |
| parent_id | |
| remote_url | |
| remote_created_at | |
| remote_updated_at | |
| custom_fields | |
| integration_fields | |
| remote_data |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Staffing Entity <> Location
Staffing Entity <> Location
| Field | Notes |
|---|---|
| staffing_entity_id | |
| location_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Staffing Entity <> Legal Entity
Staffing Entity <> Legal Entity
| Field | Notes |
|---|---|
| staffing_entity_id | |
| legal_entity_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Staffing entity <> Group
Staffing entity <> Group
| Field | Notes |
|---|---|
| staffing_entity_id | |
| group_id | |
| id | |
| changed_at | |
| remote_deleted_at |
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 |
| Feature | Notes |
|---|---|
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Custom Field Explorer | |
| Employments | |
| Connection Guide | |
| Create credentials | |
| Group Types | |
| TEAM | |
| DEPARTMENT |
The behavior of this action depends on your UKG Pro configuration. If you selected UKG Onboarding during setup, it will create a “New Hire” that needs to be onboarded. If you selected UKG Pro, it will create an employee directly in the system. For this option, you can only create employees for US Companies. If you need to create them for Canadian or Global companies, please contact support
- import-tool
- onboarding
Some optional form fields are referencing the following data models:
- Employees
Form-specific constraints
- Creates an employee directly in UKG Pro using the Import Tool API
object
required
object
required
Personal Information
Show properties
Show properties
text
required
First Name
Unified field:
Unified field:
first_nametext
required
Last Name
Unified field:
Unified field:
last_nametext
Middle Name
text
Preferred Name
text
Former Name
single_select
Name Prefix
single_select
Name Suffix
single_select
required
Gender
Unified field:
Unified field:
genderdate
required
Date of Birth
Unified field:
Unified field:
date_of_birthsingle_select
Marital Status
text
Home Phone
text
Business Phone
text
Business Phone Extension
text
Other Phone
text
Other Phone Type
text
Email Address
Unified field:
Unified field:
private_emailtext
Alternate Email
text
Mail Stop
text
Preferred Language For Pay Statement
text
Ethnic ID
text
single_select
Is Aboriginal
single_select
Is Visible Minority
object
required
Primary Address
Show properties
Show properties
text
Address Line 1
Unified field:
Unified field:
home_address.street_1text
Address Line 2
Unified field:
Unified field:
home_address.street_2text
City
Unified field:
Unified field:
home_address.citytext
required
State/Province
Unified field:
Unified field:
home_address.statetext
Country
Unified field:
Unified field:
home_address.countrytext
Zip/Postal Code
Unified field:
Unified field:
home_address.zip_codeobject
required
object
required
Job Information
Show properties
Show properties
single_select
required
Job Code
single_select
required
Location Code
Unified field:
Unified field:
location_idsingle_select
required
Pay Group
single_select
Pay Scale Code
single_select
required
Employee Type
single_select
required
Full or Part Time
single_select
required
Salary or Hourly
number
Hourly Pay Rate
number
Annual Salary
Unified field:
Unified field:
yearly_salarynumber
required
Scheduled Work Hours
single_select
Supervisor ID
References
References
/v1/hris/employees?remote_model=employeesingle_select
required
Earnings Group Code
single_select
required
Benefit Group Code
single_select
Job Group
single_select
Pay Automatically
single_select
Org Level 1 Code
single_select
Org Level 2 Code
single_select
Org Level 3 Code
object
US Taxes
Show properties
Show properties
text
Federal Filing Status Code
number
Federal Total Allowances
number
Federal Additional Amount Withheld
number
Federal Deduction Amount
single_select
Federal Employee Claims Exemption
single_select
State Unemployment Tax Plan
text
Work In Filing Status Code
number
Work In Total Allowances Claimed
number
Work In Deduction Amount
single_select
Work In Employee Claims Exemption
number
Work In Additional Amount Withheld
object
required
object
Private Information
Show properties
Show properties
text
Birth Country Code
Unified field:
Unified field:
nationalitytext
Birth Location
text
Disability Type
single_select
Is Veteran
single_select
Is Disabled
single_select
Military Branch Code
single_select
Military Era Code
single_select
Is Disabled Veteran
single_select
Is Medal Veteran
date
Military Separation Date
single_select
Is Active Wartime Veteran
date
National ID Expiration Date
text
Primary Nationality Code
Unified field:
Unified field:
nationalitytext
Secondary Nationality Code
text
Tertiary Nationality Code
single_select
text
Work Permit Country
text
Work Permit Reference ID
date
Work Permit Application Date
date
Work Permit Approval Date
date
Work Permit Expiration Date
single_select
Is Pensioner
text
I9 Visa Type
date
I9 Expiration Date
object
object
object
Emergency Contacts & Dependents
Show properties
Show properties
object
Contact Information
Show properties
Show properties
text
required
First Name
text
required
Last Name
text
Middle Name
text
Former Name
single_select
Name Suffix
single_select
required
Relationship Code
date
Date of Birth
single_select
Gender
text
SSN
text
National ID
single_select
Is Emergency Contact
single_select
Is Dependent
single_select
Is Beneficiary
checkbox
Is Active
single_select
Home Phone Country Code
text
Home Phone
text
Work Phone
single_select
Work Phone Country Code
text
Work Phone Extension
single_select
Preferred Phone
text
Email
single_select
required
Has Different Address
text
Address Line 1
text
Address Line 2
text
City
text
State/Province
text
Country
text
Zip/Postal Code
Some optional form fields are referencing the following data models:
- Employees
- Legal Entities
Form-specific constraints
- Creates a new hire in UKG Onboarding that will go through the onboarding process
object
required
Contact Information
Contact information for the new hire
Contact information for the new hire
Show properties
Show properties
object
required
Name
The name of the new hire
The name of the new hire
Show properties
Show properties
text
required
First Name
The first name of the new hire
Unified field:
The first name of the new hire
Unified field:
first_nametext
Middle Name
The middle name of the new hire
The middle name of the new hire
text
required
Last Name
The last name of the new hire
Unified field:
The last name of the new hire
Unified field:
last_nametext
Former Last Name
The former last name of the new hire
The former last name of the new hire
text
Preferred First Name
The preferred first name of the new hire
The preferred first name of the new hire
text
required
Email Address
The email address of the new hire
Unified field:
The email address of the new hire
Unified field:
private_emailtext
required
Primary Phone
The primary phone number of the new hire
Unified field:
The primary phone number of the new hire
Unified field:
mobile_phone_numbertext
Secondary Phone
The secondary phone number of the new hire
The secondary phone number of the new hire
object
Address
The address of the new hire
The address of the new hire
Show properties
Show properties
text
Street 1
The street address of the new hire
Unified field:
The street address of the new hire
Unified field:
home_address.street_1text
Street 2
The street address of the new hire
Unified field:
The street address of the new hire
Unified field:
home_address.street_2text
City
The city of the new hire
Unified field:
The city of the new hire
Unified field:
home_address.citytext
Postal Code
The postal code of the new hire
Unified field:
The postal code of the new hire
Unified field:
home_address.zip_codetext
State Code
The state code of the new hire
Unified field:
The state code of the new hire
Unified field:
home_address.statetext
Country
The country of the new hire
Unified field:
The country of the new hire
Unified field:
home_address.countrysingle_select
Country Code
ISO country code of the address
ISO country code of the address
object
Job
The job information for the new hire
The job information for the new hire
Show properties
Show properties
single_select
Job Code
UKG Pro job code
Unified field:
UKG Pro job code
Unified field:
job_titletext
Requisition ID
RequisitionId of the job
RequisitionId of the job
single_select
Component Company
Component company of the job
Unified field:
References
Component company of the job
Unified field:
legal_entity_idReferences
/v1/hris/legal-entities?remote_model=legal_entitysingle_select
Work Location
Work location of the job
Unified field:
Work location of the job
Unified field:
location_idsingle_select
Supervisor
Supervisor of the job
References
Supervisor of the job
References
/v1/hris/employees?remote_model=employeesingle_select
Employee Type
Employee type for the job
Employee type for the job
single_select
Selected FLSA Status
Selected FLSA status for the job.
Selected FLSA status for the job.
object
object
Compensation
Compensation information for the new hire
Compensation information for the new hire
Show properties
Show properties
checkbox
Is Full Time
Whether the new hire is full time
Whether the new hire is full time
checkbox
Is Salaried
Whether the new hire is salaried
Whether the new hire is salaried
number
Work Hours
Work hours of the new hire
Work hours of the new hire
number
Weekly Hours
Weekly hours of the new hire. Only applicable for hires not in US/Canadian companies
Weekly hours of the new hire. Only applicable for hires not in US/Canadian companies
text
Currency Code
ISO currency code of the new hire
ISO currency code of the new hire
number
Pay Rate
Pay rate of the new hire
Pay rate of the new hire
single_select
Rate Per
Pay period of the new hire.
Pay period of the new hire.
text
Onboarding Owner ID
External user identifier of the onboarding owner
External user identifier of the onboarding owner
text
Reference ID
Customer-provided identifier to track the new hire against their own system
Customer-provided identifier to track the new hire against their own system
date
Hire Date
Hire date of the new hire
Hire date of the new hire
date
Orientation Date
Orientation date of the new hire
Orientation date of the new hire
date
Start Date
Start date of the new hire
Unified field:
Start date of the new hire
Unified field:
start_datetext
Past Start Date Reason
Reason why the new hire start date is 4 or more business days in the past
Reason why the new hire start date is 4 or more business days in the past
object
text
Personal Message
Personal message for the new hire
Personal message for the new hire
Integration Variants
Current connector: UKG Pro For UKG Pro, we also offer the following other connector variants:UKG Pro ATS
UKG Pro for the ATS category
UKG Pro Assessment
UKG Pro for the Assessment category