Skip to content
Gallery
Boon Employer Launch Guide
Share
Explore
ATS & HRIS Integration Guides

ukg-logo
UKG Pro

Integration With Boon

Overview

This guide will walk you through retrieving your Customer API Key and creating a Service User in UKG Pro to complete your linking flow.

Prerequisites

You must be an Administrator in your company's UKG Pro instance, or someone has shared their access with you.

Instructions

Step 1: Find your UKG Pro Customer API Key

Log in to UKG Pro and search "Service Account Administration" on the top right
image.png
Copy the Customer API Key from under the header
image.png
Paste the Customer API Key in the linking flow
image.png

Step 2: Create your service account

On the Service Account Administration Page, click "+ add" on the top right
image.png
​ 2. Enter in your UKG Pro Admin's account's username and email.
3. You will need the username later
image.png
4. On the same page, scroll down under Web Service to enable "View Employee Person Details". This is REQUIRED.
image.png
5. Depending on the use case, you may also be required to add some, or all, of these permissions:
Employee Pay Statement
Employee Employment Information
PTO Plan Integration
Company Configuration Integration
Payroll Integration
Personnel Integration
Employee Job History Details
Employee Compensation Details
CleanShot 2023-12-01 at 14.29.48.png
CleanShot 2023-12-01 at 14.29.56.png
Click Save. Your new password will pop up. Save the password in a secure location
image.png
Enter your UKG Pro service account credentials in the linking flow and click Submit This is user name of your admin service user and the password you just generated
image.png

Step 3: Finding your UKG Web Service Domain

In your search bar, search for Web Services
image.png
Look at any of the URLs on this page and copy one of them. For example your URL may look something like this:
image.png
Enter the URL into the linking modal.
CleanShot 2024-06-20 at 15.43.09.png


Did this article help?


Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.