NOTE: The credential retrieval steps in this article are based on UKG's published documentation and may not reflect the latest UKG interface changes. For the most current instructions, refer to UKG's official documentation, contact UKG Support, or go to the UKG Community.
Before You Begin
Before installing the UKG Pro subscription, collect four values from UKG Pro: the API Url, API Key, API Username, and API Password. All four come from a UKG Pro web service account. If you do not already have one, create it first using the steps below.
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.
To create the service account and get the user name and password
Log in to UKG Pro as an administrator.
Go to System Configuration > Security > Service Account Administration. Administrator permission is required to open this page.
Click + Add to create a new service account.
Enter a user name and email address.
Grant the account View access to the web services this integration reads: Employee Person Details, Employee Employment Details, Compensation Details, Platform Configuration Fields, and Company Details.
Click Save. UKG Pro generates and displays the password.
Copy the password immediately and store it securely — UKG Pro displays it once and it cannot be retrieved afterwards.
To get the API key and the service URL
In UKG Pro, go to System Configuration > Security > Web Services.
Copy the Customer API Key shown on the page. UKG Pro documents this value as unique to each tenant.
Note the service hostname listed for your tenant. This is the value you will enter as the API Url, in the form
https://{hostname}.ultipro.com.
Installation Instructions for Integration Setup
Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the UKG Pro integration tile.
Click the Subscribe button.
Enter a name for the subscription and select a version. The name can be any relevant and unique subscription name within the company where the subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: UKG Pro - Production
Select Create Default Mappings (recommended). This creates the Employee and Employee Address mapping collections with their default field mappings. If you clear this checkbox, you must create every mapping manually.
Enter the API Url — the UKG Pro service host for your tenant, in the form
https://{hostname}.ultipro.com. The same host serves test and production tenants; they differ only by the tenant's own hostname.Enter the API Username, the user name assigned to the service account you created.
Enter the API Password, the password UKG Pro generated for that service account.
Enter the API Key, the Customer API Key you copied from the Web Services page.
Enter the API Throttle Limit. This and the next three fields are standard iPaaS.com subscription settings applied across the platform rather than fields specific to UKG Pro, so every subscription inherits them. The throttle limit caps how many API requests may be issued within the throttle window, protecting UKG Pro from request bursts.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds, the window over which the throttle limit is measured. The subscription ships with 60.
Enter the number of Concurrent Connections, the maximum number of simultaneous connections the subscription may open. Requests beyond the limit queue until a connection frees up. The subscription ships with 10.
Enter the number of Concurrent Batch Executions, the maximum number of batch transfers that may run at once. The subscription ships with 10. This is the one field in this group the integration reads directly, and it uses 10 when the field is left empty.
Click Apply to save the settings.
Authentication Configuration
UKG Pro Web Services authenticates every request with two credentials sent together, and does not issue a session token. There is nothing to refresh or renew on the iPaaS.com side.
Service account credentials
Credential: API Username and API Password
Location: UKG Pro → System Configuration > Security > Service Account Administration
Description: Identify the service account the integration connects as. The integration combines them into an HTTP Basic authentication header on every request.
Customer API key
Credential: API Key
Location: UKG Pro → System Configuration > Security > Web Services
Description: Identifies the tenant. The integration sends it as a dedicated header alongside the Basic authentication credentials. Both must be present for a request to succeed.
Important notes
The service account password is displayed once, at creation. If it is lost, regenerate it in UKG Pro and update the API Password field in iPaaS.com — it cannot be recovered.
The service account must retain View access to all five web services listed in Before You Begin. Removing access to any one of them causes transfers to fail even though the credentials are still valid.
When either credential is rotated in UKG Pro, update the matching field on the Subscription Settings page. The integration uses the new value on its next call.
Post-Installation Verification
After completing the installation, verify the setup.
Connection test
Save the subscription settings. The integration validates the connection by requesting your tenant's company details.
Confirm no connection error appears under Dashboard / Integration Monitoring / Error Logs.
Data sync test
Choose an employee in UKG Pro whose home-company employment status is Active or Leave, and who has an email address recorded.
Run a Manual Sync for that employee, supplying the UKG Pro EmployeeId (for example, DZOPMJ000050).
Confirm an iPaaS.com Employee record is created, carrying the employee's name and email address.
Confirm a child Employee Address record is created alongside it with the employee's home address.
This integration reads from UKG Pro only — it does not write employee data back — so there is no outbound transfer to verify.
Scheduled polling test
Schedule the poll under Dashboard / Integration Monitoring / Events.
Change an employee record in UKG Pro.
Confirm the change is captured on the next poll without running a Manual Sync.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Support Portal: https://support.ipaas.com/en/
Contact Information: https://ipaas.com/contact-us/
UKG support: UKG Support and the UKG Community