Integrations - How to Set Up a UKG Pro Integration

About this Article

In this article, we’ll run through how you can seamlessly integrate your UKG Pro system to provision and de-provision users on Reward Gateway.

How to enable the UKG Pro integration

To enable the UKG Pro integration, log into the Reward Manager portal, go to the Integration tab on the left and search for “UKG Pro” under the ”Explore Integrations” tab. 

Click on the integration icon which will lead you straight to the Initial Setup.

Setting up UKG Pro for Reward Gateway

Watch the following video which demonstrates the setup process step-by-step:

Step 1: Initial Setup

Select the import frequency, date format and whether you wish to send Welcome communication to newly added members. We recommend ticking the Welcome e-mail option, as this provides easy first-time access to the platform to new users and allows them to set up a password. 

Step 2: Authorize the UKG Pro Account

Before Reward Gateway can access your UKG Pro data, you must authorize Reward Gateway to access your UKG Pro account. To do this, click the "Authorize" button. 

This will open a modal window where you will need to enter your API key. 

How to find your API key

Login to your UKG Pro account and search Service Account Administration in your search bar on the top right.

Copy the Customer API Key from under the header.

Paste the Customer API Key in the modal window in Reward Manager and click Submit

In the next step, you will be asked to enter your credentials.

How to create your Service Account

On the UKG Pro Service Account Administration Page, click on "+ add" in the upper right-hand side.

Add in the admin of your UKG Pro account's username and email. You will need the username later.

Click Save. Your new password will pop up. Save the password in a secure location.

And lastly, add your subdomain.

How to find your UKG Web Service Domain

In your search bar, search for Web Services.

Find your top-level domain.

For example if your URL is, http://Servicet.ultipro.com/services/BIDataService then your top-level domain is "ultipro.com".

Enter your subdomain in Reward Manager.

Click Submit. On the "Enter your UKG Pro Web Services URL (Part 2)" screen, select the URL that matches your top-level domain.

You will see the confirmation message, click ‘Finish Setup’ and then ‘Save’.

In the next step, it will give you the option to map up to 10 custom fields

You can revoke access to the integration at any time.

Step 3: Mapping

Before Reward Gateway can sync your UKG Pro directory, you need to map the fields which are going to be synced. To do this, use the mapping stage of the setup and use the fields displayed. Once ready, click ‘Save’.

By default, Reward Gateway maps the Employee ID to uniquely identify a member. Any other additional mapping fields can be mapped during this stage, however, the Email Address field must be mapped as it is a mandatory field to create an account with Reward Gateway.

Once you are happy with the mapping, you can proceed to the next step.

How to prevent some members e.g. contractors creating accounts

By default, Reward Gateway fetches all active users and we use the employment status to determine if the employee is eligible. If you’d like to segment your imports and send only a specific group of employees, you can choose a field from the dropdown and set a list of allowed values and we will only create accounts for employees having these values present. You can add multiple values by separating them with commas.

Please note that if there are already existing accounts on our side, they will be revoked via the integration if you enable the segmented imports and the employees don’t have the needed values. For example, if you wish to exclude contractors, there should be a specific value by which they are grouped, and that value should not be included in the field above.

How to import custom fields to provide additional user data

We support up to 10 custom fields in addition to the standard ones in the Mapping step. They can be used so the integration fetches different information that is already included in the UKG Pro accounts.

It is important to emphasize that if the integration is already published and you want to make amendments to the custom fields, you will have to go to the Authorize step, revoke the access, and go through the Authorize step again, then map those fields and publish the integration.

Step 4: Review and Publish

At this stage, you can review the details and if you’re happy, publish the connection. This will make the integration live on the platform and Reward Gateway will start syncing the data based on the frequency selected at the Initial step.

How will you monitor when your UKG Pro data syncs?

Every time your UKG Pro data is synced, Reward Gateway sends an email to the user who set up the integration with details on how many accounts it has impacted.

You also have the option of going to the integration Dashboard and selecting the "Import History" option to see a log of all data syncs that have been performed on your platform.

If there were any issues with your data sync, you’ll be able to download a file containing all of the errors.

How will your employees get onboarded once your UKG Pro data has been synced?

If it's a new employee record that is synced from UKG Pro, Reward Gateway will create a new account for this employee based on the information mapped and will send them an invitation to join the program. 

If it's an existing employee whose data has already been synced, Reward Gateway will not issue any communication and will update their information to match their UKG Pro information.

How will the employee data be removed once an employee is removed from your UKG Pro directory?

Reward Gateway syncs your full directory every time. This means that if there is an employee missing from your UKG Pro directory but has an account on Reward Gateway, they'll be marked as an account to be removed. 

The employee's account will then follow Reward Gateway's standard account close-down procedures.

How can you trigger your membership provisioning imports on demand? 

You have the option to trigger the import on-demand from 'Import data now' link in the tools dropdown. This will redirect you to the import page where you can start the process. Once started, a progress bar will be presented and when the upload is completed, you will be able to download any warnings and see the impact on your programme.