Overview

The UKG Ready connector enables your Leena AI Agents to integrate with your organization's UKG Ready platform, facilitating automated emergency contact management and employee data workflows.

UKG Ready is a comprehensive human capital management (HCM) solution that helps organizations manage HR, payroll, talent, and time and attendance. The UKG Ready connector allows Leena AI to automate HR workflows, manage employee emergency contacts, and interact with employee data seamlessly.

API Details

Leena AI integrates with UKG Ready via REST APIs (v2).

Documentation link: https://developer.ukg.com/

Setup

The UKG Ready connector uses OAuth 2.0 authentication with the Client Credentials grant type.

Prerequisites

Before setting up the UKG Ready connector, ensure you have:

Administrator access to your UKG Ready instance
Access to UKG Ready Settings with Global Setup permissions
Ability to create OAuth applications in UKG Ready
Access to your Leena AI workspace with connector management permissions

Get credentials

Here is how to create OAuth credentials in UKG Ready:

Log in to your UKG Ready instance (Ensure you're signed in as an admin)
Navigate to Settings:
1. Click the hamburger menu (☰) on the top left
2. Click Settings menu option
3. Click Global Setup to expand the menu
4. Click Company Setup
Find Your Company ID:
1. Click the hamburger menu (☰)
2. Navigate to My team > My employees > Employee info
3. Click Select columns
4. Select Add/Remove columns
5. Add Company ID column
6. Click Apply
7. Your Company ID will be displayed
Find Your Hostname:
1. On the Company Setup page, locate your Hostname
2. This value is contained in your domain's URL login
3. Example: If your login service URL is https://secure.us.rdy.ukg/ta/company.login, then your Hostname is secure.us.rdy.ukg
Create OAuth Application:
1. On the Company Setup page, find the OAuth Applications widget
2. Choose the Machine to Machine type
3. Click Generate to create a Client ID and Client Secret
Save and Note Credentials:
1. Copy the Client ID
2. Copy the Client Secret (displayed only once during creation)
3. Note your Company ID and Hostname

Add connection

Here is how to add a connection on Leena AI:

Log in to your Leena AI workspace
Navigate to Settings > Integrations
Search for "UKG Ready" and select it from the list to add its new connector
Start configuring the connector:
1. Base URL: Your UKG Ready instance URL (e.g., https://secure.us.rdy.ukg)
2. Company ID (cid): Your UKG Ready Company ID obtained from the Company Setup
3. Company ID Prefix: The prefix character for your Company ID (typically ! or |, default is !)
4. Auth Type: Select "OAuth 2.0 Client Credentials"
5. Client ID: OAuth application Client ID from UKG Ready
6. Client Secret: OAuth application Client Secret from UKG Ready
Test and Save Connection:
1. Click Test Connection to verify the credentials
2. Once verified successfully, click Save to complete the setup
3. The connector will be saved and ready for use

Actions

The following actions are supported for the UKG Ready connector:

Get Emergency Contacts

Retrieves emergency contact information for a specific employee from UKG Ready. The Agent can leverage the skill (workflow), which has been designed to fetch emergency contact details for an employee, once the user raises a query to do so. Here are some common use cases:

Employee Profile Review: Retrieve emergency contact information during onboarding verification
Contact Verification: Validate emergency contact details for compliance purposes
HR Inquiries: Quickly access employee emergency contacts for HR representatives
Safety Protocols: Retrieve contact information during emergency situations

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Name	Description
Employee ID	The unique identifier of the employee in UKG Ready

Here is a sample JSON input:

{
  "employeeId": "EMP001234"
}

Response

Upon successful retrieval, the action returns the emergency contact details including:

Contact ID
First Name
Last Name
Relationship to employee
Phone numbers (cell, home, work)
Primary contact indicator
Additional contact information

Upsert Emergency Contact

Creates a new emergency contact or updates an existing emergency contact for an employee in UKG Ready. The Agent can leverage the skill (workflow), which has been designed to add or update emergency contact information in UKG Ready, once the user provides the contact details. Here are some common use cases:

Onboarding: Add emergency contact information for new employees
Contact Updates: Update existing emergency contact details when changes occur
Annual Reviews: Refresh emergency contact information during periodic HR reviews
Self-Service Updates: Allow employees to update their emergency contact details
Compliance Updates: Ensure emergency contact information is current and complete

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Name	Description
Employee ID	The unique identifier of the employee in UKG Ready
First Name	The first name of the emergency contact
Last Name	The last name of the emergency contact
Relationship	The relationship of the contact to the employee (e.g., Spouse, Parent, Sibling)
Cell Phone Number	The cell phone number of the emergency contact

Optional

Name	Description
Primary	Whether this is the primary emergency contact (default: true)
Salutation	The salutation/title for the contact (e.g., Mr., Mrs., Dr.)
Middle Name	The middle name of the emergency contact
Name Suffix	The name suffix of the emergency contact (e.g., Jr., Sr., III)
Cell Phone Code	The country/area code for the cell phone number
Cell Phone Primary	Whether the cell phone is the primary contact number
Work Phone Code	The country/area code for the work phone number
Work Phone Number	The work phone number of the emergency contact
Work Phone Primary	Whether the work phone is the primary contact number
Home Phone Code	The country/area code for the home phone number
Home Phone Number	The home phone number of the emergency contact
Home Phone Primary	Whether the home phone is the primary contact number
Birthdate (YYYY-MM-DD)	The date of birth of the emergency contact in YYYY-MM-DD format
Comments	Additional comments or notes about the emergency contact

Here is a sample JSON input:

//Create New Emergency Contact

{
  "employeeId": "EMP001234",
  "firstName": "Jane",
  "lastName": "Doe",
  "relationship": "Spouse",
  "primary": true,
  "cellPhone": {
    "code": "+1",
    "number": "555-123-4567",
    "primary": true
  }
}

//Complete Emergency Contact with All Details

{
  "employeeId": "EMP001234",
  "firstName": "Robert",
  "lastName": "Smith",
  "relationship": "Parent",
  "primary": false,
  "salutation": "Mr.",
  "middleName": "James",
  "nameSuffix": "Sr.",
  "cellPhone": {
    "code": "+1",
    "number": "555-987-6543",
    "primary": true
  },
  "workPhone": {
    "code": "+1",
    "number": "555-456-7890",
    "primary": false
  },
  "homePhone": {
    "code": "+1",
    "number": "555-321-0987",
    "primary": false
  },
  "birthdate": "1965-03-15",
  "comments": "Preferred contact method is cell phone during business hours"
}

//Update Emergency Contact Phone Numbers

{
  "employeeId": "EMP001234",
  "firstName": "Jane",
  "lastName": "Doe",
  "relationship": "Spouse",
  "cellPhone": {
    "number": "555-999-8888",
    "primary": true
  },
  "homePhone": {
    "number": "555-111-2222",
    "primary": false
  }
}

//Minimal Emergency Contact

{
  "employeeId": "EMP001234",
  "firstName": "Michael",
  "lastName": "Johnson",
  "relationship": "Sibling",
  "cellPhone": {
    "number": "555-444-3333"
  }
}

Response

Upon successful creation or update, the action returns the emergency contact details including:

Contact ID
Employee association confirmation
Created/updated contact properties
Timestamp of the operation
Confirmation status