Connect UKG Pro

UKG Pro is an HRIS integration that syncs employee, job, and compensation data to Pave using UKG Pro's REST API with a Web Service Account.

Before you connect

You need a Web Service Account in UKG Pro with specific permissions before connecting. A UKG Pro administrator must complete these steps.

Create a Web Service Account

1. In UKG Pro, go to System Configuration > Security > Service Account Administration.
2. On the Add/Change Service Account tab, create a new account:
   • Username: Pave
   • Password: generate a secure password
   • Email: integrations@pave.com
3. In the permissions area, check View for each of the following Web Services:
   • Employee Person
   • Employee Compensation
   • Employee Pay Statement
   • Employee User Defined Fields
   • Company Configuration Integration
   • Personnel Integration
   • Employee Job History Details
   • Employee Person Details
   • Employee Compensation Details
4. Click Save.

Get the Customer API Key and URL

1. Go to System Configuration > Security > Web Services.
2. Note the Customer API Key and URL (for example, https://service4.ultipro.com). You will need both values in Pave.

Connect UKG Pro to Pave

1. In Pave, go to Connections and find UKG Pro.
2. Enter the URL from UKG Pro Web Services (for example, https://service4.ultipro.com).
3. Enter the Customer API Key.
4. Enter the Username and Password for the Web Service Account you created.
5. Click Submit. Pave will run a verification sync to test the connection.
6. Go to Connections and verify the UKG Pro integration shows as connected.

Troubleshooting

Connection fails after submitting credentials Verify that the Username, Password, Customer API Key, and URL are all correct. The URL should be the base portion of the endpoint (for example, https://service4.ultipro.com), not a full API path.

Data is missing or incomplete Check that the Web Service Account has View permissions for all nine Web Services listed above. If specific data is missing:

• Missing location or org level data: the account may need the Company Configuration Integration permission.
• Missing custom fields: the account may need the Employee User Defined Fields permission.

Connection shows in error state Click Resolve on the UKG Pro integration in Pave to re-enter your credentials. If the issue persists, verify that the Web Service Account has not been deactivated in UKG Pro.

Fields that sync

Custom mappings may apply to your account.

• First name, last name, preferred name
• Email address, date of birth
• Gender, ethnic description
• Employee ID
• Employee type (from job history)
• Job description (job title), job code
• FLSA category (exempt status)
• Department, division
• Supervisor (resolved to manager email and name)
• Start date (from first job history entry), termination date
• Work location (city, state, country, zip code)
• Annual salary, hourly pay rate, salary/hourly indicator
• User Defined Fields (Personnel, Company, International categories)

Additional data

• Compensation history: Supported. Pave syncs salary change history from UKG Pro job history records.
• Custom fields: Supported. User Defined Fields (Personnel, Company, and International categories) sync automatically.
• Benefits: Supported.