> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# UKG Pro WFM HRIS Integration
> UKG Pro WFM connector for Kombo's HRIS API
This connector is in open beta. You can freely enable it in your account.
The UKG Pro WFM HRIS integration allows you to sync HRIS data between UKG Pro WFM and your application through Kombo's unified API. The tool slug for this connector is `ukgprowfm`.
## Guides and Resources
Step-by-step instructions to connect your UKG Pro WFM account to Kombo.
## Supported Features & Coverage
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| address | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| address | |
| type | |
| remote\_data | |
Only employees included in the HyperFind referenced by the `hyperfind_id` setting are synced. If the HyperFind is misconfigured (e.g., excludes inactive or terminated employees, filters by labor category, etc.), those employees will not appear in Kombo.
| Field | Notes |
| --------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_number | |
| first\_name | |
| last\_name | |
| display\_full\_name | |
| job\_title | |
| work\_email | |
| personal\_email | |
| mobile\_phone\_number | |
| gender | |
| employment\_status | |
| work\_location\_id | |
| legal\_entity\_id | |
| manager\_id | |
| home\_address | |
| date\_of\_birth | |
| start\_date | |
| termination\_date | |
| custom\_fields | |
| integration\_fields | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| type | |
| remote\_data | |
| Field | Notes |
| ---------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| started\_at | |
| ended\_at | |
| timezone | |
| payable\_hours | |
| unpaid\_break\_minutes | |
| breaks | |
| approval\_status | |
| approved\_at | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| employee\_id | |
| team\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.
| Input Field | Notes |
| -------------------- | ----- |
| staffing\_entity\_id | |
| properties | |
| Feature | Notes |
| ---------------- | ----- |
| Connection Guide | |
| API Passthrough | |
| Group Types | |
| TEAM | |
| DEPARTMENT | |
| COST\_CENTER | |
Some **optional** form fields are referencing the following data models:
* Employees
Consider enabling these in your [scope configuration](/hris/features/scopes).
**Person Information**
Identity, contact details, access assignment, and product licenses for the new employee.
**Person**
**Employee ID**
The employee identifier in UKG Pro WFM. Leave blank to auto-generate.
**First Name**
The first name of the employee
Unified field: `first_name`
**Last Name**
The last name of the employee
Unified field: `last_name`
**Middle Initial**
**Short Name**
A short display name. Defaults to the first name in most UKG configurations.
**Start Date**
Also used as the effective date for employment status, primary labor account, badge assignment, and base wage (unless overridden).
Unified field: `start_date`
**Date of Birth**
The employee's date of birth
Unified field: `date_of_birth`
**Email Addresses**
**Work Email**
The email address of the employee
Unified field: `work_email`
**Private Email**
The private email address of the employee
Unified field: `private_email`
**Telephone Numbers**
**Mobile Phone Number**
The mobile phone number of the employee
Unified field: `mobile_phone_number`
**Work Phone Number**
The work phone number of the employee.
**Postal Address**
**Street 1**
The street address of the employee
Unified field: `home_address.street_1`
**City**
The city of the employee
Unified field: `home_address.city`
**State**
The state of the employee
Unified field: `home_address.state`
**ZIP Code**
The ZIP code of the employee
Unified field: `home_address.zip_code`
**Country**
The uppercase two-letter ISO country (e.g., DE)
Unified field: `home_address.country`
**Access Assignment**
**Function Access Profile**
Controls the employee's system access and permissions.
**Labor Category Profile**
Controls which labor categories the employee can select.
**Product Licenses**
UKG product licenses to assign (e.g. "Hourly Timekeeping", "Analytics").
**Badge Number**
Used for time clock identification.
**Job Assignment**
Job details, primary labor account, and base wage for the new employee.
**Details**
**Pay Rule**
The pay rule for timekeeping.
**Time Zone**
The time zone for the employee's job assignment.
**Supervisor**
The employee's direct supervisor.
References `/v1/hris/employees?remote_model=employee`
**Employee Type**
The worker type as configured in UKG.
**Device Group**
The device group for time clock access.
**Organization Path**
Full organizational path for the primary labor account.
**Primary Labor Category**
Optional per-category labor entries appended to the primary labor account.
**Labor Category 1**
**Labor Category 2**
**Labor Category 3**
**Labor Category 4**
**Schedule Group**
The employee's schedule group assignment.
**Hourly Wage**
Optional hourly wage assignment for the new employee.
**Rate**
Hourly wage rate. Leave blank to skip the wage assignment.
**Effective Date**
Only applied when Rate is set. Defaults to the hire date.
**User Account**
Login credentials for the new employee.
**Account**
**Username**
The UKG login username for the new account.
**Password**
A temporary password for the new account. Must be at least 8 characters.