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 Ready subscription, gather five values from UKG Ready: the API Password, API User, API Key, Company ID, and API Url. The first four come from a UKG Ready service account, which must be created if one does not already exist.
Use a dedicated service account rather than a person's login. A regular user account ties the integration to one employee's password expiry and single sign-on policy, either of which will break the connection without warning.
To create the service account and get the API Password and User
Log in to your UKG Ready account.
Navigate to Settings > Global Setup > Security > Service Account Administration. NOTE: Admin permission is required to access the Security page.
Click + Add to create a new service account.
Enter a username and email.
Configure the required Web Services permissions. The account needs to read employees and their addresses, and to read and write time entries. Without the write permission, employee transfers succeed while timesheet transfers fail.
Click Save. UKG Ready generates and displays the password.
Copy the password immediately and store it securely — UKG Ready does not display it again.
To get the API Key
Navigate to Settings > Global Setup > Security > Service Account Administration.
The Customer API Key appears at the top of the page, and a User API Key is listed against each individual service account.
Confirm with your UKG Ready administrator which of the two applies to your environment before entering it, then copy that value.
To get the Company ID
Sign in to UKG Ready and look at the address in your browser.
The Company ID is the company identifier that appears in the UKG Ready login URL. It is a short identifier for your company, not a key.
NOTE: The Company ID and the API Key are two different values, entered in two different fields. Do not enter the Customer API Key as the Company ID.
To get the API Url
The API Url is the address of the UKG Ready environment the integration will call, in the form https://{Instance Identifier}.ultipro.com. The instance identifier is specific to the environment — a test environment and a production environment have different addresses — so take it from the environment this subscription should connect to.
Installation Instructions for Integration Setup
Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the UKG Ready integration tile.
Review the product details, then click the Subscribe button at the top right. The Supported Flows table on this page lists the mapping collections the integration provides — Employee, Employee Address, Timesheet, and Timesheet Entry.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: UKG Ready - Production
Select Create Default Mappings (recommended). This starts the subscription with the four default mapping collections and their mappings already in place. If you intend to build every mapping yourself, un-check this box.
Enter the API Password you copied when the service account was created.
Enter the API User, the username of that service account.
Enter the API Key you retrieved in Before You Begin.
Enter the Company ID, the company identifier from your UKG Ready login URL.
Enter the API Url for the environment this subscription connects to.
Review the throttling and concurrency settings. The integration pre-populates them and most subscribers do not change them:
API Throttle Limit: default 500. The maximum number of calls the integration may make to UKG Ready within each throttle window.
API Throttle Seconds: default 60. The length of each outbound throttle window, in seconds.
API Throttle Limit (To iPaaS): default 500. The equivalent limit for calls made into iPaaS.com.
API Throttle Seconds (To iPaaS): default 60. The length of each inbound window.
Concurrent Connections: default 10. How many simultaneous connections the subscription may use.
Concurrent Batch Executions: default 10. How many batch operations may run at once. This integration batches its calls, so lowering it reduces how much work runs in parallel.
Reduce these values if UKG Ready begins returning rate-limit errors. Consider reducing them for the first employee poll in particular, which retrieves the complete employee list and is the heaviest run the integration performs. 12. Click Apply to save the subscription settings.
Authentication Configuration
The integration authenticates with a username, password, and API key. There is no OAuth consent screen to complete and no authorisation to renew.
Credential | Location in UKG Ready | Description | Required |
API User | Settings > Global Setup > Security > Service Account Administration | The username of the service account the integration signs in as. | Yes |
API Password | Shown once when the service account is created | The password for that service account. | Yes |
API Key | Settings > Global Setup > Security > Service Account Administration | The API key that authorises the integration's calls. Sent alongside the sign-in credentials, not in place of them. | Yes |
Company ID | The UKG Ready login URL | The company the service account signs in against. Scopes the connection to that company. | Yes |
API Url | The environment's own address | The UKG Ready environment the integration calls. | Yes |
Important Notes
The Company ID is not an API key. It identifies your company; the API Key authorises the call. They are entered in separate fields and hold different values.
The service account password is displayed once. If it is lost, generate a new one in UKG Ready and update the API Password field on the subscription.
Rotating a credential takes effect on the next transfer. The integration signs in fresh rather than holding a session open, so there is no cached session to clear after an update.
Losing a Web Services permission breaks transfers silently in one direction. If the service account loses write permission, employee transfers continue to succeed while timesheet transfers fail with an authentication error.
Post-Installation Verification
Connection Test
After clicking Apply, confirm the subscription saved without an authentication error. If any credential is wrong, expired, or missing a Web Services permission, the error appears in Dashboard / Integration Monitoring / Error Logs. The connection does not partially succeed — either all five values are accepted or none are.
Data Sync Test
Go to the Manual Sync page and transfer a single known employee, entering that employee's numeric UKG Ready identifier.
Confirm the iPaaS.com Employee record is created with the expected name and email address, and that the employee's primary address arrived with it.
Create a timesheet in iPaaS.com for that same employee and confirm the time entries appear against the employee in UKG Ready.
Transfer an employee before testing timesheets. Timesheets for an employee who has not yet been transferred are skipped without an error.
Functionality Test
Enable employee/poll, employee/created, and employee/updated under Inbound Data Flows, and set the polling schedule.
Let one scheduled poll complete and confirm employees arrive as expected. The first run retrieves the complete employee list.
Change an employee in UKG Ready, wait for the next scheduled run, and confirm only that employee is processed.
Enable the outbound timesheet triggers under Outbound Data Flows and confirm a timesheet reaches UKG Ready.
Review Dashboard / Integration Monitoring / Error Logs for anything unexpected.
Support and Troubleshooting
For iPaaS.com:
Support Portal: https://support.ipaas.com/en/
Contact Information: https://ipaas.com/contact-us/
For UKG Ready:
Documentation: UKG Community documentation
Support: UKG Support
Community: UKG Community resources