Skip to main content

UKG Ready Connections and Settings

The credentials, subscription settings, authentication flow, and throttling controls used to connect iPaaS.com to UKG Ready, and where each value comes from.

Integrate iPaaS.com with UKG Ready to enable seamless data synchronization for employees, employee addresses, and timesheets.

How to Connect

Prerequisites

Before configuring the subscription in iPaaS.com, the following must be in place in UKG Ready:

  • A service account with Web Services permissions. The integration signs in as this account for every call it makes. Use a dedicated service account rather than a person's login, so the connection is not broken by a password change, a departure, or a single sign-on policy that does not apply to service accounts.

  • The Web Services permissions the integration needs. The account must be able to read employees and their addresses, and to read and write time entries. Without the write permission, employee transfers succeed while timesheet transfers fail.

  • The credentials themselves, listed under Configuration Details below. UKG Ready displays the service account password once, at the moment the account is created, and does not show it again — copy it before leaving the page.

For where to find each value in the UKG Ready interface, see the UKG Ready Installation Instructions.

Configuration Details

Five values connect the subscription to UKG Ready. All five are required, and the connection fails without any one of them.

  • API Url: the address of the UKG Ready environment the integration calls. It is specific to the environment, so a test environment and a production environment have different addresses. Example: https://service5.ultipro.com

  • API User: the username of the UKG Ready service account the integration signs in as. Example: ipaas-service

  • API Password: the password for that service account, generated by UKG Ready when the account is created.

  • API Key: the API key issued by UKG Ready that authorises the integration's calls. It is sent alongside the sign-in credentials rather than in place of them.

  • Company ID: the identifier of the UKG Ready company the service account signs in against. It scopes the connection to a single company.

Do not reuse a subscriber's personal UKG Ready login for any of these values.

Configure Subscription Settings

The iPaaS.com Subscription Settings page for a UKG Ready subscription, showing the credential fields and the throttling controls

Field

Description

Required

Example

Name

A unique name for this subscription within your company.

Yes

UKG Ready - Production

Versions

The integration version this subscription runs.

Yes

v1.0.0

Create Default Mappings

Shown when the subscription is first created. When selected, the subscription starts with the four default mapping collections and their mappings already in place. Leave it selected unless you intend to build every mapping yourself.

No

Selected

API Password

The password for the UKG Ready service account the integration signs in as.

Yes

Issued by UKG Ready

API User

The username of that service account.

Yes

ipaas-service

API Key

The API key issued by UKG Ready, sent with each sign-in.

Yes

Issued by UKG Ready

Company ID

The UKG Ready company the service account signs in against. Scopes the connection to that company.

Yes

Issued by UKG Ready

API Url

The address of the UKG Ready environment the integration calls. Differs between test and production environments.

Yes

https://service5.ultipro.com

API Throttle Limit

Maximum number of calls the integration may make to UKG Ready within each throttle window.

Yes

500

API Throttle Seconds

Length of each outbound throttle window, in seconds.

Yes

60

API Throttle Limit (To iPaaS)

Maximum number of calls made into iPaaS.com within each throttle window.

Yes

500

API Throttle Seconds (To iPaaS)

Length of each inbound throttle window, in seconds.

Yes

60

Concurrent Connections

Number of simultaneous connections the subscription may use.

Yes

10

Concurrent Batch Executions

Number of batch operations that may run at once. This integration groups its calls into batches, so lowering this value reduces how much work runs in parallel.

Yes

10

Webhook API Key

Generated by iPaaS.com to authenticate inbound webhook calls. UKG Ready does not send webhooks to iPaaS.com, so this integration does not use it.

No

Generated automatically

Select Apply to save the settings.

Authentication Methods

The integration authenticates with a username, password, and API key rather than an OAuth consent flow, so there is no authorisation screen to complete and no consent to renew.

  1. Enter the API Url, API User, API Password, API Key, and Company ID on the Subscription Settings page.

  2. Select Apply. iPaaS.com sends the username, password, and company identifier to UKG Ready together with the API key, and UKG Ready returns a session token.

  3. The integration uses that token for the calls it makes. Tokens are short-lived — UKG Ready issues them with a one-hour lifetime by default — and the integration signs in again as needed rather than holding a session open.

Because the integration signs in fresh rather than caching a session, a credential change takes effect on the next transfer. If a service account password is rotated in UKG Ready, update API Password on the subscription and no further action is needed; there is no cached session to clear.

If any credential is wrong, expired, or has lost its Web Services permissions, transfers fail with an authentication error that appears in Dashboard / Integration Monitoring / Error Logs. The connection does not partially succeed.

Initialization Support

Currently, the platform's Initialize Data feature is not supported for UKG Ready in iPaaS.com.

An initial load is not needed, because the employee polling event handles it. The first time the poll runs it retrieves the complete employee list from UKG Ready, so the subscription is populated by that first run. Every poll after that asks UKG Ready only for employees changed since the previous successful run.

Timesheets are not initialised. They flow from iPaaS.com to UKG Ready as outbound triggers fire, so there is no historical backfill for them. To move a large volume of existing timesheets, see the iPaaS.com guidance on bulk sync using Postman.

Throttling

The throttle settings limit how quickly the integration calls UKG Ready and how quickly it calls back into iPaaS.com. Each pair works together: the limit is the number of calls allowed, and the seconds value is the length of the window those calls are counted in. The default of 500 calls per 60 seconds applies in both directions.

These fields are pre-populated by the integration when the subscription is created, and most subscribers never change them. Reduce them if UKG Ready begins returning rate-limit errors — the Subscription Settings page carries the same advice. Raising them above the defaults is not recommended without confirming the limits that apply to the subscriber's own UKG Ready environment.

Concurrent Connections and Concurrent Batch Executions control parallelism rather than rate. Lowering either reduces the load the integration places on UKG Ready at any one moment, at the cost of slower transfers.

For details of every field on the subscription and how to change it, see Subscription Configuration - Edit.

Related Documents

Did this answer your question?