UKG Pro Integration

Contents

Overview

Customers can utilize the Betterworks UKG Pro integration to import data from UKG into Betterworks on a regular schedule. You can share updates from UKG in Betterworks without manual intervention such as:

  • Creation of new users
  • Updates to user information (i.e. change in manager, department, etc.)
  • Deactivations of users who have left your organization

Initiate Setup

To get started, there are a few specific credentials that need to be obtained from both the UKG and Betterworks:

UKG

  • Service Account
  • API URL
  • Customer API Key

To create a Service Account, simply go to:

Security → Service Account Administration: 

Screen_Shot_2022-08-05_at_1.59.41_PM.png

More details are available on the UKG website

To retrieve the API URL and Customer API Key:

1. Login into the UKG application.

2. Select the System configuration menu.

3. Click on the Web Services menu.

4. You can then access the API URL (Base URL) and Customer API Key:

Screen_Shot_2022-08-05_at_2.00.56_PM.png

Betterworks

  • API Key

1. Go to Admin → Platform Configuration → Betterworks API

2. Select a Super Admin user to generate a key for

3. Name the key

4. Click "Generate Key":

generate_api_key.png

Additional Information Required

  • Which Org Level Code should be mapped to the "department" field?
  • Should there be a blacklist (i.e. would you like to filter out users with certain properties)?

Data Load

You'll also need to complete an initial data load using the processes outlined in the following articles: 

Capture the time at which this export occurs so it may be used as the "start time" of the continuous UKG Pro integration.

Note: If you import data for a user whose department does not yet exist inBetterworks, our application will create that department for you. For example, if you import users for the Finance department, but don’t have that department in Betterworks, it will be created based on the value in the "department_name" of your file. To learn more about adding departments proactively, see this article.

Mapping

mapping.png

Reach Out

Once you've completed all of the steps outlined above, please contact the Betterworks Support Team — support@betterworks.com — with the following information so that we can complete the setup:

  • UKG Service Account
  • UKG API URL
  • UKG Customer API Key
  • UKG API credentials (username and password)
  • UKG Org Level Code (mapped to the "department" field)
  •  Blacklist (if applicable)
  • Timestamp of when the initial SFTP upload of user data was exported from UKG
  • Betterworks Super Admin API Key