New here? This page is a configuration reference for teams implementing the UKG Pro integration in iPaaS.com. It documents scope, design decisions, and settings to confirm before go-live. These are not product defects, and most items are handled during implementation by iPaaS.com or your Managed Integration Service Provider (MiSP). See Understanding Integration Scope & Known Limitations for how we document this for every integration.
These are the known limitations of the UKG Pro integration. They are inherent to the current design of the integration and to the capabilities of the UKG Pro API, and they apply to all subscribers at the time this documentation was written.
Platform Scope and Tested Versions
This integration was built for UKG Pro, UKG's human capital management product, formerly known as UltiPro.
It calls the UKG Pro Web Services REST API on the tenant's own service host, in the form https://{hostname}.ultipro.com, using three versioned service namespaces: personnel/v1, personnel/v2, and configuration/v1.
Not built for. This integration does not work with, and must not be pointed at:
UKG Ready: a separate UKG product with its own API. iPaaS.com offers a separate UKG Ready integration.
UKG Pro Workforce Management (formerly UKG Dimensions): a distinct workforce-management API surface from the UKG Pro HCM API this integration uses.
UKG Workforce Central (formerly Kronos Workforce Central): a separate legacy product line.
Any other UKG product line. If UKG launches a further product or a materially different API version in the future, this integration will not automatically support it.
Testing. The integration was last tested end-to-end against a live UKG Pro tenant on 2023-11-27. iPaaS.com does not maintain a UKG Pro sandbox for this integration, so it is not continuously tested. A Quality Assurance review is performed after a subscriber connects their own UKG Pro tenant. See the UKG Integration Note article for what that means for your implementation timeline.
1. Capture only — no write-back to UKG Pro
Every call this integration makes to UKG Pro is a read. There is no mapping collection, endpoint, or configuration that writes employee data back into UKG Pro.
What this means for you: UKG Pro is the system of record for employee data. Changes made to an employee in iPaaS.com stay in iPaaS.com and are never pushed to UKG Pro. If you need employee changes to flow back into UKG Pro, that has to happen through UKG Pro directly or through a different integration.
2. Deleted employees are not removed from iPaaS.com
The integration does not implement a delete operation, and delete mappings are not included in the default templates. Removing or terminating an employee in UKG Pro does not propagate a delete to iPaaS.com.
What this means for you: An employee removed from UKG Pro remains in iPaaS.com until someone removes them there. If your downstream processes depend on an accurate active-employee list, plan a periodic reconciliation rather than relying on deletions flowing through.
3. Change detection is polling-based, not event-driven
UKG Pro does not push employee changes to the integration, and the integration does not register webhooks. Employees are captured when a scheduled poll runs, or when someone runs a Manual Sync.
What this means for you: A change made in UKG Pro appears in iPaaS.com on the next poll rather than immediately. Choose a poll cadence that matches how quickly you need employee data to be current, and use a Manual Sync when you need a specific employee captured right away. Until a poll is scheduled under Dashboard / Integration Monitoring / Events, no automatic capture happens at all.
4. Change detection is day-level
UKG Pro matches changed employees by date rather than by timestamp, so a poll asks UKG Pro for everything changed on the relevant day. The integration then narrows the result to records changed since its last successful run.
What this means for you: Running the poll more frequently than once a day does not reduce how much UKG Pro returns each time, so a very aggressive poll schedule costs more API calls without capturing changes any sooner. A cadence of once or a few times per day is usually the right balance.
5. An interrupted poll schedule can trigger a full re-capture
The integration remembers when it last polled successfully, and that marker is retained for seven days. If polling does not run for longer than that, the marker lapses and the next poll falls back to examining the full employee history rather than only recent changes.
What this means for you: If the integration is paused, disabled, or otherwise not polled for more than a week, expect the next poll to be substantially larger and slower than usual, and to re-transfer employees that have not changed. Where possible, keep the poll running on a schedule rather than switching it off for extended periods. If a long pause is unavoidable, run it at a low-traffic time.
6. An email address is required for every employee
iPaaS.com requires an email address on every Employee record and rejects one that arrives without it.
What this means for you: Any employee who has no email address in UKG Pro will fail to transfer, and the failure appears in Dashboard / Integration Monitoring / Error Logs on every attempt. Before go-live, confirm that every employee you intend to capture has an email address recorded. Where a group legitimately has none, narrow the Employee mapping collection's filter so those records are not selected, rather than leaving them failing repeatedly.
7. Only employees with an Active or Leave status are captured
The Employee mapping collection ships with a filter that admits only employees whose home-company employment status is Active or Leave. Employees in any other status are skipped.
What this means for you: Terminated, retired, and otherwise inactive employees never reach iPaaS.com. If your use case needs them, the filter has to be widened deliberately. Confirm the filter matches your definition of which employees belong in iPaaS.com before enabling the collection.
8. Employment status changes do not remove employees already captured
The filter governs which employees are captured, not which are removed. An employee already in iPaaS.com whose UKG Pro status later moves outside the filter simply stops receiving updates.
What this means for you: Your iPaaS.com employee list will accumulate people who have since left, holding whatever values they had at their last successful transfer. Treat the iPaaS.com roster as "employees captured at some point" rather than "currently active employees," and reconcile separately if you need the latter.
9. Only the home address is captured, and only with its employee
UKG Pro carries a single home address inline on the employee record rather than as separate address records. The integration captures that address and no other, and always as part of its employee's transfer — the address collection is never invoked on its own.
What this means for you: Work, mailing, and emergency-contact addresses are not captured, and each employee produces exactly one iPaaS.com address. If a downstream process needs a different address type, it will not find it here. An address also cannot be refreshed on its own: to re-capture one after it changes in UKG Pro, transfer its employee again, either by waiting for the next poll or by running a Manual Sync on the employee.
10. Unmapped iPaaS.com fields are cleared on every update
iPaaS.com uses a full record replace when updating records, so any destination field that is not mapped is overwritten with an empty value on every transfer. In the default templates, PictureLink on the Employee record and Name and Address3 on the Employee Address record are not mapped.
What this means for you: If you populate any of those three fields in iPaaS.com by another means, the next transfer of that employee will clear them. To preserve a field, split the combined Add/Update collection into separate Add and Update collections and add a Dynamic Formula mapping in the Update collection that carries the existing value forward — for example DestinationValue.PictureLink. Decide this before go-live; the values are not recoverable once cleared.
11. Employees are matched by their external-ID link
The integration does not offer configurable collision handling for employees. Records are matched solely by the external-ID link iPaaS.com records after the first successful transfer.
What this means for you: There is no option to choose how conflicts are resolved when a matching employee already exists. If the external-ID link is ever cleared, a subsequent transfer creates a new iPaaS.com Employee rather than re-linking to the existing one, because no primary-identifier field is mapped to fall back on.
12. Employees are loaded by poll or manual sync, not bulk initialization
Initialization — loading an existing population in one pass when the subscription is first connected — is not supported for UKG Pro in iPaaS.com.
What this means for you: The first poll captures employees changed since the integration's start point rather than the entire roster. To load an existing employee population, use bulk sync using Postman, which drives the same transfer path the poll uses.
13. Employment and compensation details are not mapped
The integration retrieves each employee's employment and compensation records to identify their home company and read their employment status, but the fields on those records are not mapped into iPaaS.com by the default templates.
What this means for you: Job title, salary, pay rate, hire date, and similar employment and compensation attributes are not captured. Only the employee's name, email address, and home address transfer.
This document covers 13 known limitations. For detailed technical documentation of what each mapping collection transfers, see the mapping collection descriptions in iPaaS.com and the UKG Pro to iPaaS.com Employee Mapping Documentation article.
