top of page

The Complete UKG Pro Integration Guide (Stop Chasing Missing Payroll Data)

  • Mar 30
  • 4 min read


To build a seamless, automated pipeline between UKG Pro and Benefit Cloud, you need a precise strategy.

Unlike simpler platforms that only require a quick login, enterprise-grade systems like UKG Pro require highly secure, specific configurations to ensure your sensitive employee data remains completely protected.

By following these exact steps, you will establish an unbreakable digital connection.


Step 1: Create a Service Account


Your first major task is establishing a safe pathway for data to travel.

The first step is to create a dedicated service account in your UKG Pro system for Benefit Cloud. You do not want to use a regular employee's login for this, as employee roles and access levels change over time.


Instead, this account will be used exclusively for secure API access to sync your data.


Here is the exact process to get this set up correctly:

  • Log into your UKG Pro administrator account.


  • Navigate to the user management or service accounts section.


  • Create a new service account specifically for Benefit Cloud.


  • Ensure this account is set up as a service/API account (not a regular user account).


  • The account should have appropriate permissions to access employee and payroll data.


By setting up a dedicated service account, you are creating a secure, trackable foundation for your HR integration.

Step 2: Gather Required Credentials


Now that you have created the service account, you need the digital keys to unlock it.

Once the service account is created, you'll need to collect several API keys and credentials to provide to Benefit Cloud. These credentials enable secure authentication and access to your UKG Pro data.


Think of these credentials as the highly secure combination to a bank vault. You need all six pieces to make the lock turn.

Here are the specific required credentials you must gather:

  • Username: Service account username. Collect the service account Username.


  • Password: Service account password. Securely note the service account Password.


  • Customer API Key: Typically 5 characters. Locate the Customer API Key.


  • User API Key: API key for user authentication. Obtain the User API Key.


  • Web Services API Key: API key for web services. Retrieve the Web Services API Key.


  • Client ID: Typically 3 characters (sometimes labeled "US-Client-ID"). Find the Client ID.


Pro-Tip: If you are struggling to locate your Client ID, it can be found by navigating to System Configuration > Company Setup and referring to the value for Primary Company Code.


Step 3: Grant Endpoint Access


With your account created and your keys in hand, you now need to tell UKG Pro exactly which doors Benefit Cloud is allowed to open. In the technical world, these doors are called "endpoints."

Configure the service account to have access to the necessary API endpoints. UKG Pro offers numerous endpoints, and comprehensive access ensures smooth data synchronization.


Here is how to map your data flow:


  • Navigate to the endpoint access configuration page for the service account.


  • You'll see a list of available endpoints or services.


  • Grant access to all endpoints that are even remotely relevant to employee and payroll data.


  • When in doubt, enable access to additional endpoints - UKG Pro data points are highly intertwined.


It is highly recommended to enable access to all relevant endpoints, as UKG Pro data points are highly intertwined and comprehensive access ensures smooth data synchronization.


Key endpoints include Employee PayStatement, EmployeePerson, and Employee EmploymentInformation.


For example, these endpoints might look like this:


Step 4: Share Credentials with Benefit Cloud


You’ve done the heavy lifting. Now, it is time to hand over the configuration details so our systems can finally shake hands.


Securely provide all collected credentials to the Benefit Cloud team so we can establish the connection to your UKG Pro system. Security is critical here; do not compromise your sensitive employee payroll data.


Follow these strict secure-sharing guidelines:


  • Send the credentials via secure email to your Benefit Cloud representative or support@benefitcloud.io.


  • Include all six required items: Username, Password, Customer API Key, User API Key, Web Services API Key, and Client ID.


  • We recommend using a secure file sharing method or encrypted email for credential transfer.


Once received, our team will securely store these credentials and begin the integration setup. Be aware that this typically takes 1-2 business days to process and configure.


Step 5: Integration Complete


The days of exporting messy spreadsheets are over. You are all set! Benefit Cloud will begin securely syncing your payroll and employee data from UKG Pro.


So, what happens next in the process?

  • The Benefit Cloud team will perform initial setup and connection testing.


  • We'll verify access to all necessary endpoints and data.


  • You'll receive confirmation once the integration is fully active.


  • Data will sync automatically based on your agreed-upon schedule.


As your organization grows, your dedicated account manager will be available for any questions or adjustments.


Need Help Upgrading Your Workflow?


Implementing enterprise-level system architecture can sometimes feel overwhelming, but the long-term rewards are undeniable.


If you have any questions or encounter any issues during the integration process, our support team is here to help.

Comments


bottom of page