Connect UKG Ready
Connect UKG Ready
Note: The UKG Ready integration is in beta. General availability is planned for November 2026.
UKG Ready is an HRIS integration that syncs employee, job, and compensation data to Pave using an OAuth application you create in UKG Ready. UKG Ready is a separate product from UKG Pro. If your company uses UKG Pro, see Connect UKG Pro.
Before you connect
- You need administrator access in UKG Ready to create an OAuth application and edit security profiles.
- Pave needs read-only access. Pave only reads data from UKG Ready and never writes to it.
- You enter four values in Pave: an API URL, a Company Short Name, a Client Id, and a Client Secret.
Connect UKG Ready to Pave
-
In UKG Ready, go to Admin, then Profiles/Policies, then Security, and click New Security Profile. Name it (for example, "Pave"), turn on View for these items, and click Save. Items are listed by tab and section.
- Global - Company Setup: Additional Compensation Fields
- Global - Global Setup: Company EINs, Cost Center Definitions, Cost Center Trees, and Jobs
- Global - Object Lists: Company EINs, Cost Centers, and Jobs
- HR - Employee Management: Employee Information (My Team & Group Punch), Account/Personal Information (Manager Access), Additional Compensation, Base Compensation, Cost Centers, Demographics, HR Custom Values, Jobs, and Total Compensation
- HR - HR Tables: Pay Grade
- HR - Position Management: Positions and Employee Assignments
- Modules - REST API Resources: Employees, Employee Demographics, Employee HR Custom Fields, and Employee Pay Information
- If you use Pave only for Market Data, you can leave Demographics and Employee Demographics off.
-
Go to Settings, then Global Setup, then Company Setup, then Login Config, and open the OAuth Applications tab.
- If you don't see an OAuth Applications tab, click Edit Tabs on the Login Config page, add OAuth Applications, and click Save.
-
Add an OAuth application for Pave:
- Application Type: Machine to Machine
- Security Profile: The profile you created in step 1
- Account Access: Leave Edit off, and set Account Groups to All company employees
-
Click Generate Secret, and copy the Client Id and Secret before you click Save. UKG Ready shows the secret only once and you can't retrieve it later.
-
Collect your tenant details:
- API URL: The address of your UKG Ready tenant, including
https://and with no trailing slash. For example,https://secure5.saashr.com. - Company Short Name: Found on the Company Setup page in UKG Ready, or in the address you use to log in. For example, if the address ends in
/ta/acme.home, your Company Short Name isacme.
- API URL: The address of your UKG Ready tenant, including
-
In Pave, go to Settings, then Connections, and find UKG Ready. Enter all four values and click Submit.
Troubleshooting
Connection shows an error after you submit: Pave checks your credentials and read access as soon as you click Submit. If the check fails, the connection shows an error. Confirm that the API URL, Company Short Name, Client Id, and Client Secret match your UKG Ready tenant and OAuth application, and that the security profile includes every item listed in step 1. Then re-enter your details and click Resolve.
API URL is not accepted: The API URL must start with https:// and have no trailing slash, path, or port.
Company Short Name is not accepted: The Company Short Name must be at least two letters or numbers, with no spaces or symbols. It is the short name from your UKG Ready login address, not your full company name.
Sync fails because some employees can't be read: Pave checks that it can read compensation for every employee in UKG Ready. If the OAuth application has access to a smaller account group than All company employees, the sync fails. Give the application access to All company employees.
You lost your client secret or need to rotate it: UKG Ready doesn't let you view a secret again after you leave the page. Generate a new secret for the Pave application in OAuth Applications, then go to Settings, then Connections in Pave and enter the new secret.
After you connect
- Pave syncs UKG Ready data every hour, and each sync covers your full employee population.
- Employees who move between entities or countries in UKG Ready keep a single record in Pave.
Fields that sync
Custom mappings may apply to your account.
Employee fields
- First name, last name
- Email address
- Employee ID
- Start date
- Employment type
- Manager name and email
- Location (city, state, country, and ZIP code from the employee's address)
- Gender
Job fields
- Job title
- Job family
- Pay grade
Compensation fields
- Base salary
- Hourly rate, for employees paid hourly
- Bonus
- Commission (as variable pay)
- Currency
Additional data
- Compensation history: Supported for base salary. Pave syncs past changes back to each employee's start date, and each change keeps the currency it was paid in.
- Bonus and commission: Supported with configuration. UKG Ready lets each company name its own additional compensation types. Pave maps a type to bonus when its name includes "bonus" and to variable pay when its name includes "commission." Types that UKG Ready already counts in base salary are skipped so they aren't counted twice. Other types are mapped for your account during setup.
- Custom fields: Supported with configuration. UKG Ready returns custom fields without labels, so Pave works with you to map them to the right fields in Pave.
- Benefits: Not supported.
