Important Note:
- UKG Pro and Ultipro are essentially same API endpoints. Any customer using UKG Pro and UltiPro should be able to follow following to connect.
To authenticate with UKG Pro, you need:
- Service Account Username - The username for your UKG Pro service account
- Service Account Password - The password generated for your UKG Pro service account
- Customer API Key - Your UKG Pro Customer API Key found in Service Account Administration
- Hostname - The tenant URL of your UKG Pro instance (e.g. servicet.ultipro.com)
This guide will walk you through finding your Customer API Key, setting up a service account, and locating your hostname.
Prereqs: You must have UKG Pro system administrator rights to create service accounts
Step 1: Finding Your Customer API Key
To find your Customer API Key in UKG Pro:
Open the Service Account Administration page
- Click “Settings” from the side menu
- Go to the “Security” tab
- Select “Service Account Administration”
Locate your Customer API Key
- The Customer API Key will be displayed at the top of the page
Step 2: Creating a Web Service Account
To create a service account:
- On the Service Account Administration page, click the Add (+) button located at the top right of the page
-
Enter Service Account Details
- Enter a username for the account
- Provide an email address
-
Assign Permissions
- In the Web Services table, assign the appropriate permissions for the API resources you need to access
-
Save and Generate Password
- Click the Save button at the top of the page
- A new password will be generated for the account
Step 3: Finding Your Hostname
To locate your hostname:
- Navigate to System Configuration > Security > Web Services
- Your hostname will be the domain of your service URL (e.g. servicet.ultipro.com)
- The full service URL might look like “**https://servicet.ultipro.com/services/**”
- You only need the hostname portion (servicet.ultipro.com)
Step 4: Enter credentials in the Connect UI
- Log in to your AllVoices Dashboard.
- Click the gear icon (⚙️) in the navigation bar.
- Go to “Integrations.”
- Click “Connect Integration” in the top-right corner.
- Choose UKG Pro from the platform list.
- Enter your credentials.
That’s it—your Workday account is now connected to AllVoices!
Baseline Fields that will be Synced:
- Baseline fields are the standard fields across all HRIS integrations. This helps with demographic charts, exit surveys, and pushing data back accurately.
In July (first month of release), we will be fetching the following fields.
In August, we will enable our customers to be able to choose which fields to sync from the following.
- exception: any field with
payorsalaryinfo will NOT be pulled in and is excluded.
Field |
Value Type |
|---|---|
| id | string |
| firstName | string - Required |
| lastName | string |
| string - Required | |
| displayName | string |
| employeeNumber | string (optional) |
| title | string |
| department.id | string |
| department.name | string |
| employmentType | 'FULL_TIME' |
| employmentStatus | 'ACTIVE' |
| startDate | string (ISO date) |
| terminationDate | string (ISO date, optional) |
| manager.id | string (optional) |
| manager.firstName | string (optional) |
| manager.lastName | string (optional) |
| manager.email | string (optional) |
| workLocation.name | string |
| workLocation.type | 'OFFICE' |
| workLocation.primaryAddress.street | string (optional) |
| workLocation.primaryAddress.city | string (optional) |
| workLocation.primaryAddress.state | string (optional) |
| workLocation.primaryAddress.country | string (optional) |
| workLocation.primaryAddress.postalCode | string (optional) |
| workLocation.primaryAddress.type | 'WORK' |
| addresses[].street | string |
| addresses[].city | string |
| addresses[].state | string |
| addresses[].country | string |
| addresses[].postalCode | string |
| addresses[].type | 'HOME' |
| phones[].type | 'WORK' |
| phones[].number | string |
| emails[].type | 'WORK' |
| emails[].address | string |
| createdAt | string |
| updatedAt | string |
UKG Pro Specific Fields
UKG Pro Specific |
| personId |
| userIntegrationKey |
| companyId |
| fullTimeOrPartTime |
| jobCode |
| projectCode |
| orgLevel2Code |
| orgLevel3Code |
| orgLevel4Code |
| prefix |
| suffix |
| gender |
| emplStatusStartDate |
| dateInJob |
| dateOfLastHire |
| jobGroupCode |