This connector is in open beta. You can freely enable it in your account.
ukgpro.
Guides and Resources
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 |
Absences
Absences
We currently only fetch absences for 2 years in the past or future. Please contact Kombo support if you need absences outside of this time range.
| Field | Notes |
|---|---|
| id | |
| changed_at | |
| remote_deleted_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 | |
| effective_date | |
| remote_data | |
| custom_fields | |
| integration_fields |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type | |
| remote_data |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create employee with form
Create employee with form
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| properties |
| Feature | Notes |
|---|---|
| Connection Guide | |
| Create credentials | |
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Group Types | |
| TEAM | |
| DEPARTMENT | |
| Custom Field Explorer | |
| Employments |
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
Personal Information
Show properties
Show properties
First Name
Unified field:
Unified field:
first_nameLast Name
Unified field:
Unified field:
last_nameMiddle Name
Preferred Name
Former Name
Name Prefix
Name Suffix
Gender
Unified field:
Unified field:
genderDate of Birth
Unified field:
Unified field:
date_of_birthMarital Status
Home Phone
Business Phone
Business Phone Extension
Other Phone
Other Phone Type
Email Address
Unified field:
Unified field:
private_emailAlternate Email
Mail Stop
Preferred Language For Pay Statement
Ethnic ID
Is Aboriginal
Is Visible Minority
Primary Address
Show properties
Show properties
Address Line 1
Unified field:
Unified field:
home_address.street_1Address Line 2
Unified field:
Unified field:
home_address.street_2City
Unified field:
Unified field:
home_address.cityState/Province
Unified field:
Unified field:
home_address.stateCountry
Unified field:
Unified field:
home_address.countryZip/Postal Code
Unified field:
Unified field:
home_address.zip_codeJob Information
Show properties
Show properties
Job Code
Location Code
Unified field:
Unified field:
location_idPay Group
Pay Scale Code
Employee Type
Full or Part Time
Salary or Hourly
Hourly Pay Rate
Annual Salary
Unified field:
Unified field:
yearly_salaryScheduled Work Hours
Supervisor ID
References
References
/v1/hris/employees?remote_model=employeeEarnings Group Code
Benefit Group Code
Job Group
Pay Automatically
Org Level 1 Code
Org Level 2 Code
Org Level 3 Code
US Taxes
Show properties
Show properties
Federal Filing Status Code
Federal Total Allowances
Federal Additional Amount Withheld
Federal Deduction Amount
Federal Employee Claims Exemption
State Unemployment Tax Plan
Work In Filing Status Code
Work In Total Allowances Claimed
Work In Deduction Amount
Work In Employee Claims Exemption
Work In Additional Amount Withheld
Private Information
Show properties
Show properties
Birth Country Code
Unified field:
Unified field:
nationalityBirth Location
Disability Type
Is Veteran
Is Disabled
Military Branch Code
Military Era Code
Is Disabled Veteran
Is Medal Veteran
Military Separation Date
Is Active Wartime Veteran
National ID Expiration Date
Primary Nationality Code
Unified field:
Unified field:
nationalitySecondary Nationality Code
Tertiary Nationality Code
Work Permit Country
Work Permit Reference ID
Work Permit Application Date
Work Permit Approval Date
Work Permit Expiration Date
Is Pensioner
I9 Visa Type
I9 Expiration Date
Direct Deposit Information
Show properties
Show properties
Account Number
Account Is Inactive
Amount or Percentage
Account Type
Routing Number
Bank Name
Deposit Rule
Institution Number
Is Pre-Note
Emergency Contacts & Dependents
Show properties
Show properties
Contact Information
Show properties
Show properties
First Name
Last Name
Middle Name
Former Name
Name Suffix
Relationship Code
Date of Birth
Gender
SSN
National ID
Is Emergency Contact
Is Dependent
Is Beneficiary
Home Phone
Work Phone
Work Phone Extension
Email
Has Different Address
Address Line 1
Address Line 2
City
State/Province
Country
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
Contact Information
Contact information for the new hire
Contact information for the new hire
Show properties
Show properties
Name
The name of the new hire
The name of the new hire
Show properties
Show properties
First Name
The first name of the new hire
Unified field:
The first name of the new hire
Unified field:
first_nameMiddle Name
The middle name of the new hire
The middle name of the new hire
Last Name
The last name of the new hire
Unified field:
The last name of the new hire
Unified field:
last_nameFormer Last Name
The former last name of the new hire
The former last name of the new hire
Preferred First Name
The preferred first name of the new hire
The preferred first name of the new hire
Email Address
The email address of the new hire
Unified field:
The email address of the new hire
Unified field:
private_emailPrimary Phone
The primary phone number of the new hire
Unified field:
The primary phone number of the new hire
Unified field:
mobile_phone_numberSecondary Phone
The secondary phone number of the new hire
The secondary phone number of the new hire
Address
The address of the new hire
The address of the new hire
Show properties
Show properties
Street 1
The street address of the new hire
Unified field:
The street address of the new hire
Unified field:
home_address.street_1Street 2
The street address of the new hire
Unified field:
The street address of the new hire
Unified field:
home_address.street_2City
The city of the new hire
Unified field:
The city of the new hire
Unified field:
home_address.cityPostal Code
The postal code of the new hire
Unified field:
The postal code of the new hire
Unified field:
home_address.zip_codeState Code
The state code of the new hire
Unified field:
The state code of the new hire
Unified field:
home_address.stateCountry
The country of the new hire
Unified field:
The country of the new hire
Unified field:
home_address.countryCountry Code
ISO country code of the address
ISO country code of the address
Job
The job information for the new hire
The job information for the new hire
Show properties
Show properties
Job Code
UKG Pro job code
Unified field:
UKG Pro job code
Unified field:
job_titleRequisition ID
RequisitionId of the job
RequisitionId of the job
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_entityWork Location
Work location of the job
Unified field:
Work location of the job
Unified field:
location_idSupervisor
Supervisor of the job
References
Supervisor of the job
References
/v1/hris/employees?remote_model=employeeEmployee Type
Employee type for the job
Employee type for the job
Selected FLSA Status
Selected FLSA status for the job.
Selected FLSA status for the job.
Compensation
Compensation information for the new hire
Compensation information for the new hire
Show properties
Show properties
Is Full Time
Whether the new hire is full time
Whether the new hire is full time
Is Salaried
Whether the new hire is salaried
Whether the new hire is salaried
Work Hours
Work hours of the new hire
Work hours of the new hire
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
Currency Code
ISO currency code of the new hire
ISO currency code of the new hire
Pay Rate
Pay rate of the new hire
Pay rate of the new hire
Rate Per
Pay period of the new hire.
Pay period of the new hire.
Onboarding Owner ID
External user identifier of the onboarding owner
External user identifier of the onboarding owner
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
Hire Date
Hire date of the new hire
Hire date of the new hire
Orientation Date
Orientation date of the new hire
Orientation date of the new hire
Start Date
Start date of the new hire
Unified field:
Start date of the new hire
Unified field:
start_datePast 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
Personal Message
Personal message for the new hire
Personal message for the new hire