Skip to main content

UKG Ready integration guide

Ophelia Boamah Ampoh
  • Updated

The UKG Ready integration with Deel Payroll allows you to keep your HRIS system as the source of truth for employee data, eliminating the need for manual data entry.

This article explains how to configure Deel and UKG Ready so that you can sync data between them.

In this article

Here’s what you’ll find in this article:

Before you begin

To successfully set up the UKG Ready integration, you’ll need:

  • A user with an admin role on Deel with permission to view and connect integrations and manage plugins in Apps & Automation
  • A service user role on UKG Ready
  • A Deel Payroll entity on Deel with time off policies
  • Multi-EIN (Employer Identification Number) enabled in UKG Ready if you plan to run more than one payroll group
Info
UKG Ready does not currently support mapping custom fields as pay groups. This means that to use multiple payroll groups in Deel, you must configure your UKG Ready tenant as multi-EIN. If your organization is not set up with multi-EIN, only the default payroll group will be available.

Do not use guessed or placeholder UKG Ready credentials. Obtain them from your UKG Ready administrator or integration owner.

We recommend checking the UKG Ready integration reference and UKG Ready security profile to understand the integration's features and limitations before starting to follow this guide.

Address mapping and integration behavior

What the UKG Integration Syncs

The UKG integration syncs specific employee data fields from UKG to Deel. Understanding what is and isn't synced helps prevent confusion about data flow and approvals.

Address Mapping Limitations

  • Contract Address only: The integration syncs the Contract Address field only from UKG to Deel.
  • Not synced: Personal home addresses and postal addresses are NOT synced or updated by the integration.
  • Manual entries: If a home or postal address appears in Deel, it was entered manually through the Deel UI, not from the UKG sync.

Approval Request Triggers

Understanding when approval requests appear in Deel helps clarify what data came from the integration versus manual entries.

  • Synced updates (no approval needed): Changes synced directly from UKG to Deel (such as contract address updates or department changes) apply immediately and do not trigger an approval request.
  • Manual entries (approval triggered): If an approval request for an address or profile change appears in Deel, it means the change was entered manually in the Deel UI by a worker or admin—it did not originate from the UKG sync.

Example: If a worker's contract address changes in UKG, it syncs to Deel automatically with no approval step. But if a worker manually updates their home address directly in the Deel UI, Deel may trigger an approval workflow depending on your organization's settings.

Step 1. Prepare UKG Ready

In this section, we’ll guide you through how to configure UKG Ready so that you can connect to it.

To connect UKG Ready to Deel, prepare your base URL, username, password, company short name, and API key.

To get your API key:

  1. Go to Settings > Global Setup > Company Setup, then navigate to the Login Config tab.
  2. Generate and copy your API key.

Info
Before proceeding to connect the integration, go to Global Setup > Company Setup > Global Policies, and ensure that the Employee ID format in UKG Ready is set to Alpha-Numeric.
EE id format.png

Required Employee Fields in UKG Ready

For employee data to sync successfully from UKG Ready to Deel, certain fields must be populated in your UKG Ready system for each employee:

Mandatory Fields

  • Full-Time Equivalent (FTE): This field is required for all employees. It represents the employee's full-time equivalent status as a decimal:
    • 1.0 = 100% full-time
    • 0.5 = 50% part-time (or other fractional values as applicable)
    • If this field is missing or blank for any employee in UKG Ready, the sync will fail for those employees in Deel.
  • Job History: This field must be populated for employees whose job information needs to be synced to Deel.

Troubleshooting Sync Failures

If employees do not appear in Deel after connecting the integration:

  1. Log into UKG Ready and navigate to the employee record
  2. Verify the FTE field is populated with a valid decimal value (e.g., 1.0, 0.5, 0.75)
  3. Verify Job History is populated where applicable
  4. Ensure your UKG Ready service account has the permissions described in Step 1

Once these fields are populated, initiate a manual sync or wait for the next automatic daily sync at 9am GMT.

Step 2. Connect the integration

In this section, we’ll guide you through how to connect Deel to UKG Ready.

To connect to UKG Ready:

  1. In the left sidebar, expand Apps & Automation, then select App Store.

  1. If the optional Welcome to your Deel Apps & Integrations dialog appears, dismiss it using I'll do that later or the X. On Apps overview, enter UKG Ready in the Find apps field.

  1. Select UKG Ready® and confirm it is identified by the description HR, Payroll, & Workforce Management Solution.

  1. On the UKG Ready® integration page, select Connect UKG Ready®.

  1. In Account credentials, enter your account credentials. Select Connect after completing all required fields.
UKG Ready account credentials Where to find it
Base URL Your organization’s UKG Ready environment URL
Username The username of your service user
Company short name Settings > Global Setup > Company Setup on the Company Info tab.
Password The password of your service user
Customer API key Settings > Global Setup > Company Setup on the Login Config tab.
  1. At the Notification settings step, enter one or more email addresses where to receive integration notifications, then click Connect.

The integration is now connected and you can start to configure the integration. A connected integration provides a Plugins tab.

Step 3. Configure the integration

In this section, we’ll guide you through configuring the integration so that data can sync successfully.

After connecting UKG Ready, you need to configure:

Set up employee data sync

This plugin automatically syncs direct employee data (onboarding, amendments, and terminations) from UKG Ready to Deel.

To configure the employee data sync plugin:

  1. From the connected UKG Ready integration page, go to the Plugins tab.
  2. Click Enable on the Deel Payroll - Employee data sync plugin.
  3. On the plugin page, click Add Entity.
  4. On the Entity details step, select the applicable UKG Ready pay group and Deel entity, payroll group, and team.
  5. On the Global field mapping step, ensure the mandatory Deel fields are mapped with UKG Ready values and optional ones (cost centers, employee custom fields, or country-specific fields).
  6. On the Test and fix wizard, we recommend running a test to identify possible issues early, but you can skip the test by clicking Continue.
  7. On the Enable sync step, turn on sync for your pay group and click Complete setting.

Enable the employee data sync plugin

After setting up the employee data sync plugin, you need to enable it.

To enable the employee data sync plugin:

  1. From the UKG Ready integration page, go to the Plugins tab.
  2. Open Deel Payroll - Employee data sync.
  3. On the plugin page, click Enable.

The employee data sync plugin is configured; employee data will automatically sync between UKG Ready and Deel.

Configure the time off plugin

This plugin syncs your direct employees' time off logged in UKG to Deel to be used to process payroll.

Info
The employee data sync is required to configure the time off sync.

To configure the time off plugin:

  1. From the connected UKG Ready integration page, go to the Plugins tab.
  2. On the Deel Payroll - Time off sync plugin, click Enable.
  3. Find the Deel Payroll entity that should receive time-off data and click Configure.
  4. Verify the selected entity, then click Confirm. Match each Deel time off type to at least one time off type from your HRIS.
  5. Click Confirm.
  6. On the Enable sync modal, click Enable sync.

The time off plugin is configured and logged direct employee time off will begin syncing.

Configure the auto sync of payslip plugin

This plugin allows you to sync payslips to UKG Ready so that your team can have access to payslip and tax documents.

To configure the auto sync of payslip plugin:

  1. From the connected UKG Ready integration page, go to the Plugins tab.
  2. On the Deel Payroll - Auto sync of payslip plugin, click Enable.

The auto sync of payslip plugin is configured, payslips will begin syncing.

Step 4. Sync data manually

Automatic syncs occur daily, but you can manually trigger a sync:

  • If you’ve made important changes and need them to sync immediately
  • If you notice missing data or errors that suggest that the last sync didn’t complete correctly

To sync data:

  1. In the left sidebar, expand Apps & Automation, then select App Store.
  2. Search for UKG Ready in Find apps and select the UKG Ready® result.
  3. If Sync UKG Ready is available, click it to start the manual sync. If the page instead shows Connect UKG Ready®, complete Step 2 first.

Recent changes in employee data will be synced from Deel to UKG Ready.

UKG Ready integration reference

This section provides information about the integration's capabilities and limitations. You can use it to understand whether the integration can sync the data you need to sync.

Supported contract type

The UKG Ready integration supports the Deel Payroll contract type.

Supported sync entities

The UKG Ready integration supports the sync of the following entities:

  • Employee data
  • Time off
  • Payslips
  • Compensation info

Mandatory sync fields

Mandatory Deel fields are applied globally; ensure they are mapped with UKG Ready values.

The UKG Ready integration supports the sync of the following mandatory fields:

Mapped from Deel Description Mapped by default to
First Name Employee’s legal first name First Name
Last Name Employee’s legal last name Last Name
Employee Number Employee’s identifier Employee Id
Address Line 1 Employee’s primary address Address Line 1
City City where the employee is based City
Zip code Postal/ZIP code for the employee’s address Zip Code
Pay rate Employee’s current compensation amount Compensation Information Amount
Pay rate time frame Frequency of pay rate Compensation Information Time Period
Compensation Effective date Date when the current pay rate takes effect Compensation Information Effective From
Country Country where the employee is based Country
Job Title Employee’s job title
JobDetail Jobs (HR)
Job Info Effective date Date when the employee’s current job details (title, etc.) were updated Date Started
Email Employee’s primary work email address
Primary Email
Start Date Employee’s official hire/start date
Date Started
Full time percentage Employee’s FTE status (e.g., 100% for full-time, 50% for part-time)
FTE
Employee type Classification (e.g., full-time, part-time) Employee Type
Employment Effective date Date when the current employment type took effect Date Started
Was this article helpful?
0 out of 0 found this helpful
Was this article helpful?
not helpful
very helpful
Return to top

Related articles