Skip to main content
View as MarkdownOpen in ChatGPTOpen in Claude

UKG Ready setup

UKG Ready connects through the unified HRIS connector. This page covers the UKG-side configuration you complete first. Once it's done, add the connector in Mesh by following Connect your HR system.

UKG Ready asks for more values than most providers. You finish with five:

ValueWhere it comes from
DomainThe host you sign in at
Company short nameCompany Setup → Company Info
API keyCompany Setup → Login Config
Service account user IDA service account you create
Service account passwordSet when you create the account

Before you start​

You need administrator access to your company's UKG Ready instance, or a colleague who has it.

Third-party product

These steps reflect Axiad's current understanding of UKG Ready's configuration. Because UKG Ready is a third-party product, there may be variations between your experience and what this guide describes, depending on the version in use and recent updates.

If you find a significant difference, or anything that doesn't make sense, let us know through Axiad support.

Step 1 — Note your domain​

Your domain is the host portion of your UKG Ready sign-in URL, without any path. If you sign in at acme.com/ta/Default.login, the domain is acme.com.

The connection window asking for the UKG Ready domain

Step 2 — Find your company short name​

  1. Sign in to UKG Ready and open the menu at the top left. Go to the settings icon, then Global Setup → Company Setup.

    The UKG Ready menu open at Global Setup, Company Setup

  2. Open Company Info.

    The Company Info section of Company Setup

  3. Scroll to Company Address and copy the Company Short Name.

    The Company Short Name field under Company Address

Step 3 — Find your API key​

  1. On the Company Setup page, open Login Config.

    The Login Config section of Company Setup

  2. Scroll to API Keys and select the eye icon to reveal the key, then copy it.

    Generating a new key can break existing integrations

    If no key exists, select Generate to create one. If a key is already there, reuse it rather than regenerating — other integrations may be authenticating with the existing key, and replacing it stops them working.

Step 4 — Create a service account​

Mesh reads from UKG Ready as a dedicated service account rather than as a person, so the connection keeps working when individuals join or leave. Create the account in UKG Ready, note its user ID, and set a password you can retrieve.

Step 5 — Connect in Mesh​

Follow Connect your HR system, choose UKG Ready in the connection window, and supply the five values in turn.

The connection window collecting the UKG Ready credentials

After connecting​

The connector appears in your connectors list with Health: Initializing while the first collection runs, then moves to Good. Access is read-only: Mesh does not write back to UKG Ready.

If it doesn't come online, see Troubleshoot HR connectors.

Troubleshooting​

What you seeLikely causeFix
Authentication is rejectedThe domain includes a path, or the company short name was read from the wrong fieldUse the host only, and take the short name from Company Info → Company Address
Another integration stops working after setupThe API key was regenerated rather than reusedReissue the key to the other integration, or restore the previous one
The connector authorizes but collects nothingThe service account lacks read access to employee recordsWiden the service account's permissions in UKG Ready, then re-run the collection