> For the complete documentation index, see [llms.txt](https://integrations.drivetrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.drivetrain.ai/integration-guide/readme/hris-and-ats/integrating-with-ukg-pro.md).

# Integrating with UKG Pro

[Prerequisites](#prerequisites)

[UKG Pro Setup](#ukg-pro-setup)\
[Step 1: Find your UKG Pro Customer API Key](#step-1-find-your-ukg-pro-customer-api-key)\
[Step 2: Create your Service Account](#step-2-create-your-service-account)\
[Step 3: Find your UKG Web Service Domain](#step-3-find-your-ukg-web-service-domain)

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* An active UKG Pro account.
* Admin privileges on UKG Pro.
* Admin privileges in Drivetrain.

## UKG Pro Setup <a href="#ukg-pro-setup" id="ukg-pro-setup"></a>

Drivetrain connects to UKG Pro via an API key and a Service Account. To create this integration, you need to log in using an admin account to find the API key, create a Service Account with the relevant permissions, and then provide the Web Services URL. This guide will cover the steps for the above requirements.

### Step 1: Find your UKG Pro Customer API Key <a href="#step-1-find-your-ukg-pro-customer-api-key" id="step-1-find-your-ukg-pro-customer-api-key"></a>

1. Log in to your UKG pro account and search “**Service Account Administration**” on the top right.

<figure><img src="/files/6h0U9u0PINE9UF9C4KYx" alt=""><figcaption></figcaption></figure>

2. Copy the Customer API Key from under the header and copy it in a secure document.

<figure><img src="/files/mzXmPNb0Ogejl1jiZ1BN" alt=""><figcaption></figcaption></figure>

### Step 2: Create your Service Account <a href="#step-2-create-your-service-account" id="step-2-create-your-service-account"></a>

1. On the Service Account Administration Page, Click “**+ add**” on the top rig

<figure><img src="/files/qwePYYHgvXa07EeQOMwk" alt=""><figcaption></figcaption></figure>

2. Enter the username as “Drivetrain Integration” and reach out to your CSM for email.

<figure><img src="/files/Z9evoHwWMcrm8Jd14vUC" alt=""><figcaption></figcaption></figure>

3. Under the Web Services section, enable the relevant permissions. To capture complete employee and payroll-related information, refer to the permissions listed below. Note that the "Employee Person Details" permission is mandatory.
   * Employee Person Details \[This is required for integration, Permissions Needed: View]
   * Employee Pay Statement \[Permissions Needed: View]
   * Employee Employment Information \[Permissions Needed: View]
   * PTO Plan Integration \[Permissions Needed: Add & View]
   * Company Configuration Integration \[Permissions Needed: Add & View]
   * Payroll Integration \[Permissions Needed: Add & View]
   * Personnel Integration \[Permissions Needed: Add & View]
   * Employee Job History Details \[Permissions Needed: View]
   * Employee Compensation Details \[Permissions Needed: View]

<figure><img src="/files/HpE5GoSRd21msmBwJCKQ" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/VOV6iF45KLY1nnAS33Ue" alt=""><figcaption></figcaption></figure>

4. Click on Save on top right. Your new password will pop-up, save the password in a secure document along with the API key found in Step 1

<figure><img src="/files/bUgaJmRdgxcGxW74ATvJ" alt=""><figcaption></figcaption></figure>

### Step 3: Find your UKG Web Service Domain <a href="#step-3-find-your-ukg-web-service-domain" id="step-3-find-your-ukg-web-service-domain"></a>

1. Go back to home, click on Search Bar and search for “**Web Services**”.

<figure><img src="/files/pgyEikbvLEwMlpca9ozf" alt=""><figcaption></figcaption></figure>

2. Copy any one of the URL present on the page and add in the same document where you stored password and API key. As an example below your URL may look something like this: [http://Servicet.ultipro.com/services/BIDataService](http://servicet.ultipro.com/services/BIDataService)

<figure><img src="/files/kQI9wAeqw5ifoE6d5j0K" alt=""><figcaption></figcaption></figure>

***

### Drivetrain Setup

After completing the UKG Pro setup above, connect UKG Pro as a data source in your Drivetrain instance. You must be a **Drivetrain administrator** to add a data source.

#### Step 1: Go to the Data page and add a data source

1. Sign in to your Drivetrain instance as an administrator.
2. In the left navigation, click **Data**.
3. At the top of the data sources panel, click the **+** (Add data source) button.

<figure><img src="/files/VjQf5ET4Wbwz3tQMbzP3" alt=""><figcaption></figcaption></figure>

#### Step 2: Select the UKG Pro connector

1. In the **Connect a datasource** window, search for **UKG** (or open the **HRIS & ATS** category).
2. Click the **UKG Pro** connector card.

<figure><img src="/files/X2gZCij4LM8tJDTN8NXf" alt=""><figcaption></figcaption></figure>

#### Step 3: Confirm administrator access

1. The UKG Pro connection window opens with the message **"Administrator role required."**
2. Click **I am an admin** to continue.

<figure><img src="/files/4kXLurnOz89YLGhNCI7j" alt=""><figcaption></figcaption></figure>

#### Step 4: Enter your API Key

Paste the **Customer API Key** you acquired from Step 1 of the UKG Pro setup, then click **Next**

<figure><img src="/files/G3Bb3muLz2OwgoytYj4h" alt=""><figcaption></figcaption></figure>

#### Step 5: Finish setup

1. Once the credentials are validated, the connection is created and you are returned to the **Data** page.
2. **UKG Pro** now appears in your list of connected data sources and begins syncing.
3. When the sync completes, your UKG Pro data is available across Drivetrain.

{% hint style="info" %}
If you have any questions or run into any issues during setup, please contact your customer success manager for assistance.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.drivetrain.ai/integration-guide/readme/hris-and-ats/integrating-with-ukg-pro.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.