Integrate iPaaS.com with UKG Pro to enable seamless data synchronization for employee records and their home addresses.
How to Connect
Prerequisites
Before configuring the subscription in iPaaS.com, create a UKG Pro web service account and collect its credentials. UKG Pro documents this under Web Service Account (UKG Developer Hub, retrieved 2026-07-29).
In UKG Pro, go to System Configuration > Security > Service Account Administration. Administrator permission is required to open this page.
Create a service account with a user name and email address, and grant it View access to the web services the integration reads: Employee Person Details, Employee Employment Details, Compensation Details, Platform Configuration Fields, and Company Details.
Save the account. UKG Pro generates the password and displays it once — copy it immediately and store it securely, because it cannot be retrieved later.
Note the customer API key and the tenant's service hostname, both shown under System Configuration > Security > Web Services.
Use a dedicated service account rather than a named employee account. A named account's password expiry, or its enrolment in single sign-on, will break the integration when it changes.
Configuration Details
API Url: The tenant's UKG Pro service host, in the form
https://{hostname}.ultipro.com. Found under System Configuration > Security > Web Services. Example:https://service5.ultipro.comAPI Username: The user name assigned to the service account created above. This is separate from any employee login account. Example:
ipaas_svcAPI Password: The password UKG Pro generated when the service account was created. Displayed once at creation and not retrievable afterwards.
API Key: The customer API key for the tenant, shown under System Configuration > Security > Web Services. UKG Pro documents this value as unique to each tenant.
Configure Subscription Settings
Field | Description | Required | Example |
Name | The subscription name shown throughout iPaaS.com. | Yes |
|
Versions | The integration version the subscription runs. | No |
|
API Url | The tenant's UKG Pro service host. Every API call the integration makes is built on this value. | Yes |
|
API Key | The tenant's customer API key, sent on every request alongside the service account credentials. | Yes |
|
API Username | The service account user name used for authentication. | Yes |
|
API Password | The service account password generated by UKG Pro. | Yes |
|
API Throttle Limit | Maximum number of API requests the integration may issue within the throttle window, protecting UKG Pro from bursts. | Yes |
|
API Throttle Seconds | The window, in seconds, over which the throttle limit is measured. | Yes |
|
API Throttle Limit (To iPaaS) | The same limit applied to calls made into iPaaS.com while capturing records. | Yes |
|
API Throttle Seconds (To iPaaS) | The window, in seconds, for the iPaaS.com-side throttle limit. | Yes |
|
Concurrent Connections | Maximum number of simultaneous connections the subscription may open. Requests beyond the limit queue until a connection frees up. | Yes |
|
Concurrent Batch Executions | Maximum number of batch transfers that may run at once for this subscription. | Yes |
|
Webhook API Key | Generated by iPaaS.com when the subscription is created. Read-only; it is not entered by the subscriber. | No | (generated) |
Authentication Methods
UKG Pro Web Services authenticates each request with two credentials sent together, and does not issue a session token. Every call the integration makes carries both.
Enter the service account user name in API Username and its password in API Password. The integration combines them into an HTTP Basic authentication header.
Enter the tenant's customer API key in API Key. The integration sends it as a
US-CUSTOMER-API-KEYheader.Enter the tenant service host in API Url. The integration builds every request path on this value.
Save the subscription. The integration validates the connection by requesting the tenant's company details; a failure surfaces the message UKG Pro returned under Dashboard / Integration Monitoring / Error Logs.
Because no token is issued, there is nothing to refresh or expire on the iPaaS.com side. When either credential is rotated in UKG Pro, update the matching field here — the integration begins using the new value on its next call. A service account password is displayed only once at creation, so a lost password must be regenerated in UKG Pro rather than recovered.
Initialization Support
Currently, initialization is not supported for UKG Pro in iPaaS.com. All data synchronization and mappings must be configured manually during the integration process.
To load an existing employee population into iPaaS.com for the first time, subscribers or their MiSP can use bulk sync using Postman, which drives the same transfer path the scheduled poll uses.
Throttling
Throttling limits how quickly the integration issues API calls, protecting both UKG Pro and iPaaS.com from request bursts and keeping the subscription within the capacity available to it. The API Throttle Limit sets how many requests may be issued within the window defined by API Throttle Seconds; the paired (To iPaaS) fields apply the same control to calls made into iPaaS.com while records are captured.
These are standard iPaaS.com subscription settings applied across the platform rather than fields specific to UKG Pro, so every subscription inherits them, and most subscribers never need to change them. Concurrent Batch Executions is read directly by this integration, which uses 10 when the field is left empty; the remaining throttle and concurrency fields are enforced by the iPaaS.com platform rather than by the integration. Lowering the limit or lengthening the window paces the integration more conservatively, which is the first adjustment to make if UKG Pro begins reporting that too many requests have been made. UKG Pro does not publish rate-limit figures for the endpoints this integration calls, so the right values are best established by observation.
For details on editing these fields, see Subscription Configuration – Edit.