> ## Documentation Index
> Fetch the complete documentation index at: https://help.gowindmill.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Pro

> Connect UKG Pro to Windmill to sync employees, managers, departments, and employment data so your org chart and access controls stay accurate automatically.

## Benefits of Connecting UKG Pro to Windmill

Connecting UKG Pro to Windmill keeps your employee directory and reporting structure continuously accurate — without manual updates. When UKG Pro is the system of record, Windmill automatically:

* Imports new hires as they join
* Updates manager → direct report relationships
* Reflects promotions, reorgs, and title changes
* Archives employees when they leave the company

This ensures review cycles, 1:1s, and feedback always align to your **current org** — no spreadsheets, no double entry.

## Connected Data

Windmill syncs the following employee fields from UKG Pro:

| Field                                   | Description                                          |
| --------------------------------------- | ---------------------------------------------------- |
| Employee Name                           | Full legal name                                      |
| Work Email                              | Used as the account identity in Windmill             |
| Job Title                               | Displayed in profiles and review cycles              |
| Manager Relationship                    | Drives org structure, reviews, and 1:1 pairings      |
| Department / Org Unit                   | Used for grouping and cycle assignment               |
| Employment Status (Active / Terminated) | Automatically archives former employees              |
| Start Date                              | Supports new-hire ramp reviews and onboarding timing |
| Time Off                                | Tracks Days Off for team availability insights       |

**Windmill does not sync compensation, pay statements, benefits data, home address, or sensitive personal information.**

## How to Connect UKG Pro to Windmill

Windmill connects to UKG Pro through [Merge](/integrations/merge), using a dedicated service account in your UKG Pro instance. The full walkthrough with screenshots is available in Merge's guide: [UKG Pro — How do I link my account?](https://help.merge.dev/articles/5696209-ukg-pro-how-do-i-link-my-account?lang=en)

<Note>
  You'll need an **Administrator** role in UKG Pro (or delegated administrator
  access) to complete these steps.
</Note>

<Steps>
  <Step title="Retrieve your Customer API Key">
    Log in to UKG Pro and use the search bar in the top right to navigate to **Service Account Administration**. Copy the **Customer API Key** displayed under the header and paste it into the linking window in Windmill.
  </Step>

  <Step title="Create a service account">
    On the **Service Account Administration** page, click **+ add** in the top right. Create a username and email for the service account — save the username, you'll need it in a moment.

    In the **Web Service** section, enable the permissions listed in [Recommended Permissions](#recommended-permissions) below. Click **Save** and store the generated password securely, then enter the service account username and password into the linking window.
  </Step>

  <Step title="Configure the Web Service domain">
    Search for **Web Services** in UKG Pro and copy one of the displayed service URLs (for example, `http://servicet.ultipro.com/services/BIDataService`). Enter this URL into the linking window to complete the connection.
  </Step>
</Steps>

## Recommended Permissions

When creating the service account, UKG Pro lets you choose which Web Service permissions to grant. Enable the following:

| Permission                        | Purpose                                                        |
| --------------------------------- | -------------------------------------------------------------- |
| View Employee Person Details      | **Required** — names, emails, and core profile data            |
| Employee Employment Information   | Employment status, hire dates, and job details                 |
| Personnel Integration             | Person and employment records used to build your org structure |
| Employee Job History Details      | Keeps titles and role changes current                          |
| PTO Plan Integration              | Time off data                                                  |
| Company Configuration Integration | Company-level configuration such as org levels and job codes   |

Leave the remaining permissions **disabled** — Windmill does not use them:

* Employee Pay Statement
* Employee Compensation Details
* Payroll Integration
* Employee User Defined Fields

**Windmill is read-only and never writes back to UKG Pro.**

<Tip>
  If some employee fields come back empty after connecting, the service account
  is likely missing the permission for that data type. Grant the corresponding
  Web Service permission and resync — see [Common issues with UKG
  Pro](https://help.merge.dev/articles/6698965-common-issues-with-ukg-pro) for
  details.
</Tip>

## Managing Employee + Manager Updates

If you need to:

* Change someone's manager
* Update a title or department
* Move an employee to a new team
* Archive someone who has left

> **Make these updates in UKG Pro.**

Windmill treats UKG Pro as the **source of truth**.\
Any edits made directly in Windmill will be **overwritten** on the next sync.

## FAQs

<AccordionGroup>
  <Accordion title="How often does the sync run?">
    Automatically every **24 hours**, with the option to trigger a manual sync in Windmill.
  </Accordion>

  <Accordion title="What is Merge?">
    Merge is the unified API platform that powers Windmill's UKG Pro integration, providing secure and reliable connectivity to your HRIS (Human Resources Information System). [Learn more about Merge](/integrations/merge).
  </Accordion>

  <Accordion title="Does this affect payroll or benefits?">
    No — the integration is strictly **read-only** and doesn't touch payroll, pay statements, or benefits data. We recommend leaving the payroll and compensation permissions disabled on the service account.
  </Accordion>

  <Accordion title="What if I don't have administrator access in UKG Pro?">
    Ask your UKG Pro administrator to complete the connection, or have them delegate administrator access to you. Creating the service account and API key requires an **Administrator** role.
  </Accordion>

  <Accordion title="Do contractors sync?">
    Only if they appear in UKG Pro as active workers with a manager assigned.
  </Accordion>
</AccordionGroup>

***
