Integrating with UKG Pro
Last updated
Was this helpful?
Last updated
Was this helpful?
An active UKG Pro account.
Admin privileges on UKG Pro.
Admin privileges in Drivetrain.
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.
Log in to your UKG pro account and search “Service Account Administration” on the top right.
Copy the Customer API Key from under the header and copy it in a secure document.
On the Service Account Administration Page, Click “+ add” on the top right.
Enter the username as “Drivetrain Integration” and reach out to your CSM for email.
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]
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.
Go back to home, click on Search Bar and search for “Web Services”.
Share the document containing below information to your Drivetrain’s CSM or Solutions Consultant.
Customer API Key [Found in Step 1]
User Name & Password [Service Account User Created in Step 2]
Web Services URL [Found in Step 3]
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:
