How do I set up the UKG Pro integration?

Last updated: June 19, 2026

Connect Onboarded to UKG Pro so a new hire's onboarding data flows into payroll. You'll set your credentials, sync UKG's code tables, choose which fields to collect, and let your payroll team submit each new hire from one review task.

Before you start

  • Admin access to your account's Integrations settings.

  • Your UKG Pro API credentials: the UKG Pro base URL, a UKG service user (username and password), and your Customer API key.

  • A UKG service user with permission to read code tables and post new hires.

Connect your UKG Pro credentials

  1. Open the integration. From your account settings, open Integrations and choose UKG Pro.

  2. Enter your credentials. Fill in your UKG Pro base URL, the Username and Password for your UKG service user, and your Customer API key. The password is stored encrypted at rest.

  3. Save. If you rehire former employees through Onboarded, turn on Allow posting rehires, then select Save & Continue. The integration will show as Configured.

Sync UKG's code tables

Onboarded fills coded dropdowns — company, location, job, and similar fields — from UKG's own code tables, so the values your team picks always match what UKG expects.

  1. Open the Fields step and select Sync code tables.

  2. Confirm the sync. Wait for each table to show a Synced status. If one shows Failed or Partial failure, select Retry sync.

A sync pulls the full set of values UKG has configured, not a shortlist. Long code tables can make dropdowns hard to scan, and labels come straight from UKG — often legal entity names rather than the business names your managers recognize. Use the field defaults and Required toggles below to keep the review task tight, and adjust labels in UKG Pro if they're confusing.

Choose which fields to collect

  1. Review the field table in the Fields step. Each field has a Section, a Label, an Assignee (Employee or Employer), a Required toggle, and a Default value. Use Search fields… to jump to a specific field.

  2. Assign and trim. Set the Assignee to Employer for anything your payroll team owns rather than the new hire — accruals and auto-pay settings are common examples. Toggle Enabled off for fields you don't collect, then select Save.

How a new hire reaches UKG Pro

The integration adds a UKG Pro task — an employer-facing review form that gathers everything UKG needs in one place. It sits late in the task sequence so the new hire's own forms are finished first. The task consolidates employee info, job information, federal and state withholding, direct deposit, and accruals. Your payroll team confirms the employer-owned fields and selects Submit to UKG Pro.

If UKG rejects the submission, Onboarded surfaces the validation errors inline and the task highlights the fields to fix. Once UKG accepts it, the task shows Submitted to UKG Pro.

Many teams trigger an automation that emails payroll once the new hire and their manager finish, with a link straight to the UKG Pro task.

Verify

A new hire is wired up correctly when their UKG Pro task opens with the code-table dropdowns populated, the employer-owned fields waiting for payroll, and Submit to UKG Pro available. After submitting, the status reads Submitted to UKG Pro.

If dropdowns are empty, re-run Sync code tables. If Submit to UKG Pro stays disabled, a required field is still empty — the task highlights which one.

Related