Skip to main content

UKG Ready: Advanced HCM Integration

Advanced HCM Data Integration securely connects Emissary with ATS and HCM platforms like UKG Ready to sync candidate and employee data and automate workflows.

Advanced HCM Data Integration enables organizations to seamlessly retrieve candidate and employee data from their Applicant Tracking System (ATS) or Human Capital Management (HCM) platform, including systems such as UKG Ready. By securely synchronizing workforce data, Emissary ensures recruiting and employee information remains current and accessible, allowing teams to automate workflows, personalize communications, and build integrations without the need for manual data exports or maintenance.

How It Works

When integrating with UKG Ready, Emissary authenticates using OAuth client credentials. Client ID and Client secret must be generated in the UKG Ready platform and provided to Emissary. Emissary will then securely retrieve information on a scheduled basis, ensuring data remains up to date while adhering to the organization’s security and access controls.

Setup

In order for the integration to work we need to provision the authentication credentils based on OAuth 2.0 client credentials flow. This is done by creating a new application in the UKG Ready platform and generating a Client ID and Client Secret.

Create the Security Profile

  1. Navigate to Settings -> Profiles/Policies -> Security.

  2. Click on New Security Profile.

  3. Use ‘Emissary’ for the security profile name.

  4. Set the description to reflect the usage of this profile by the Emissary Integration.

  5. Under Security Items set the following permissions:

    1. HR:

      • Employee Management -> Documents: View/Edit and check both Add/Delete

      • Employee Management -> Notes: View and check both Add/Delete

      • Recruitment -> Applicants: View/Edit and check Add and See All Applicants

      • Recruitment -> Job Application Status: View

      • Recruitment -> Job Applications: View and check See All Job Applications

      • Position Management -> Positions: View (w/o Amounts)

      • Position Management -> Employee Assignments: View (w/o Amounts)

    2. Modules

      • Rest API Resources -> Applicants: View, Edit and See All Applicants

      • Rest API Resources -> Job Application: View

      • Rest API Resources -> Employee Profiles: View

      • Rest API Resources -> Employees: View

Create Authentication Credentials

  1. Log in to UKG Ready

  2. Navigate to Settings -> Global Setup -> Company Setup

  3. Switch to the Login Config tab and check that OAuth Applications is shown. If not present add it by using the Edit Tabs option.

  4. Click on ADD OAUTH APPLICATION button and create a new set of credentials with the following details:

    • Name: Emissary Integration.

    • Application Type: Machine to Machine.

    • Client Id: Copy the Client Id for future reference.

    • Secret: Click on GENERATE SECRET and copy it to a safe location for future reference.

    • Security Profile: Select the Security Profile “Emissary” steps to create on the next section.

    • Under Account Access select the System All Company Employees group.

  5. Click Save.

Configure in Emissary

After the previous steps have been completed, the integration can be configured in Emissary by providing a small set of connection details. These include the OAuth Client ID, Client Secret (created in the previous step) and API Domain and Company ID.

  1. Log in to Emissary and select the Integrations page on the main side bar

  2. Click on Add Integration

  3. Name your integration and select the ATS/type, in this case UKG Ready

  4. Fill in each of the requested parameters and click Save

  5. The system will check the provided credentials and if they work properly it will let you know that you are done with the integration process.

Configuration Parameters

Company ID

Also called Company Short Name can be obtained from UKG Ready by following these steps:

  1. Go to Global Setup -> Company Setup -> Company Info -> Company Address

  2. Look for the Company Short Name field and copy the value. This is the Company ID that will be used in Emissary

API Domain

API Domain is the server part from the URL you use to connect to your UKG instance.

Did this answer your question?