Overview

The UKG Pro WFM connector enables your Leena AI Agents to integrate with your organization's UKG Pro Workforce Management platform, automating employee time off (leave) workflows such as checking balances, viewing history, submitting requests, and managing manager approvals.

UKG Pro Workforce Management (formerly UKG Dimensions) is UKG's workforce management suite for scheduling, timekeeping, and absence management. The UKG Pro WFM connector allows Leena AI to automate time off operations for both employees and managers, so requests can be raised, tracked, and actioned directly through the Agent.

API Details

Leena AI integrates with UKG Pro WFM via REST APIs.

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

Setup

The UKG Pro WFM connector uses OAuth 2.0 authentication. Three authentication methods are supported, so you can match the connection to how your tenant is provisioned:

• OAuth 2.0 resource owner password credentials — authenticates with a service account username and password against your tenant's token endpoint.
• OAuth 2.0 authorization code (same base and token URL) — standard authorization code flow where the authorization and token requests share the same base URL.
• OAuth 2.0 authorization code (different auth & token URLs) — authorization code flow for tenants where the authorization URL and the token URL are on different hosts (for example, federated / IdP-based sign-in).

Prerequisites

Before setting up the UKG Pro WFM connector, ensure you have:

• Administrator access to UKG Pro Workforce Management
• An employee with Developer Admin permissions to generate an app key (via the "Generate and Access App Keys" topic in the UKG Developer Hub)
• A client created in UKG Pro WFM under Administration > Time application setup > Common setup > Client management, which provides the Client ID and Client Secret
• Your tenant's Base URL (hostname), and — for the authorization code flows — the Authorization URL and Token URL
• Access to your Leena AI workspace with connector management permissions

Get credentials

The credentials are issued from your UKG tenant. Here is how to obtain them:

1. Sign in to UKG Pro Workforce Management with an administrative account that has Setup access.
2. Have an employee with Developer Admin permissions generate an app key for your integration.
3. Create a client to obtain the Client ID and Client Secret:
   1. Navigate to Administration > Time application setup > Common setup > Client management.
   2. Create a new client.
   3. Copy the Redirect URI from the Leena AI platform and enter it in both the Redirect URL and Logout redirect url fields while creating the client.
   4. Note the generated Client ID and Client Secret for use in the Leena AI connection.
4. Identify (or create) the service account used for API access, ensuring it has access to the employees, locations, and time off data required for the actions you plan to automate.
5. For the authorization code flows, note your Authorization URL and Token URL, and be ready to whitelist the Leena AI Redirect URI (generated by Leena AI) as an allowed redirect URI on the UKG side.

Add connection

Here is how to add a connection on Leena AI:

1. Log in to your Leena AI workspace.
2. Navigate to Settings > Integrations.
3. Search for "UKG Pro WFM" and select it from the list to add its new connector.
4. Select the Auth type and configure the fields for the chosen authentication method.

OAuth 2.0 resource owner password credentials

OAuth 2.0 authorization code (same base and token URL)

OAuth 2.0 authorization code (different auth & token URLs)

5. Complete the OAuth flow and save the configuration.
6. For the authorization code flows, copy the Redirect URI from Leena AI and add it to the allowed/whitelisted redirect URIs on the UKG side, then save.

Actions

The following actions are supported for the UKG Pro WFM connector:

Get time off balance

Retrieves the time off balance (accruals) for an employee in UKG Pro WFM. The Agent can leverage the skill (workflow) designed to look up an employee's available balance for a given time off subtype as of a specific date, once the user raises a query to do so.

Input Parameters

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

Mandatory

Here is a sample JSON input:

{
  "params": {
    "subtype_id": "VACATION",
    "date": "2025-08-27"
  }
}

Response

The action returns the accrual/balance details for the requested subtype, including the available balance as of the specified date.

Get time off history

Retrieves the time off history for an employee in UKG Pro WFM. This action can be leveraged by the Leena AI Orchestrator/Agent to list an employee's time off requests over a date range.

Input Parameters

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

Mandatory

Here is a sample JSON input:

{
  "payload": {
    "where": {
      "employee": {
        "employeeRef": { "qualifier": "EMP001" },
        "startDate": "2025-08-01",
        "endDate": "2025-08-31"
      }
    }
  }
}

Response

The action returns a list of the employee's time off requests within the date range, including subtype, period(s), amount, and current status.

Apply time off

Submits a time off request for an employee in UKG Pro WFM. The Agent can leverage the skill (workflow), which has been designed to create a new time off request, once the user raises a query to do so.

Input Parameters

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

Mandatory

Optional

Here is a sample JSON input:

{
  "params": {
    "person_number": "EMP001"
  },
  "payload": {
    "requestSubType": {
      "id": "VACATION"
    },
    "periods": [
      {
        "startDate": "2025-08-27",
        "endDate": "2025-08-28",
        "symbolicAmount": {
          "qualifier": "FULL_DAY"
        },
        "payCode": {
          "id": "PTO"
        }
      }
    ]
  }
}

Response

Upon successful submission, the action returns the created time off request details, including the request identifier and its current status.

Update time off status

Updates the status of a time off request in UKG Pro WFM. The Agent can leverage the skill (workflow) designed to change the state of an existing time off request (for example, to cancel it), once the user specifies the request to update.

Input Parameters

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

Mandatory

Here is a sample JSON input:

{
  "payload": {
    "changeState": {
      "do": {
        "toStatus": {
          "name": "Cancelled"
        }
      },
      "where": {
        "timeOffRequestId": "123456"
      }
    }
  }
}

Response

Upon a successful update, the action returns the updated time off request details, including the new status.

Get pending time off approval requests

Retrieves pending time off approval requests from UKG Pro WFM. This action can be leveraged by a manager's Agent to list time off requests awaiting action for a set of employees over a date range.

Input Parameters

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

Mandatory

Here is a sample JSON input:

{
  "payload": {
    "where": {
      "states": {
        "completionState": "SUBMITTED",
        "employeeRefs": {
          "qualifiers": ["EMP001", "EMP002"]
        },
        "startDate": "2025-08-01",
        "endDate": "2025-08-31"
      }
    }
  }
}

Response

The action returns the list of pending time off approval requests matching the criteria, including the employee, period, subtype, and request identifier.

Apply time off (as manager)

Applies a time off request as a manager in UKG Pro WFM. The Agent can leverage the skill (workflow) designed to submit a time off request on behalf of an employee, once the manager provides the request details.

Input Parameters

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

Mandatory

Optional

Response

Upon successful submission, the action returns the created time off request details, including the request identifier and its current status.

Update time off status (as manager)

Updates a time off request status as a manager in UKG Pro WFM. The Agent can leverage the skill (workflow) designed to approve, reject, or otherwise change the state of an employee's time off request, once the manager specifies the request and target status.

Input Parameters

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

Mandatory

Response

Upon a successful update, the action returns the updated time off request details, including the new status.