Prerequisites

• Please ensure that the person setting up the connection is an Administrator in the UKG Pro WFM instance, otherwise the connection will not work.

Find your API credentials

1. Log into your UKG Pro WFM instance.
2. Click on the hamburger icon on the top-left corner to view the side menu.
3. Click on "Time Setup".
4. It will open a new tab in your browser with the Application Setup. Click on "Common Setup".
5. Click on "Client Management".
6. Click on "Create" to create a new client.
7. Creating a Client: 
   1. Enter an appropriate name and description according to your use case.
   2. Set Application Flow as "Interactive".

   3. Set Grant Type as "Password Flow (ROPC)".

      

   4. Click on "Save" and you should be able to see the Client ID, Realm, and Organization ID almost immediately. Please wait for a few seconds for the Client Secret to be generated. 
      
   5. You can find your API Hostname in the URL of your UKG Pro WFM instance.
       

UKG Pro WFM Onboarding

1. Enter the API Hostname (from Step 5 in the section above), along with the Username and Password (they are the same credentials you used to login into your UKG Pro WFM instance as an Administrator).

    

2. Enter the Client ID and Client Secret which you saved from Step 4 in the above section.
    

3. Kombo syncs the employees that your selected Hyperfind returns. In the next step, "Create or Select a Hyperfind", you can either create a new Hyperfind or select an existing one from the dropdown list.

   For a detailed walkthrough on how to create and set up a Hyperfind in UKG Pro WFM, see UKG Pro WFM: How to create & setup Hyperfind.
   
   Create a new Hyperfind (recommended)

   • Select "Create a new Hyperfind" from the dropdown.
   • Enter a name for the new Hyperfind (if left empty, it defaults to "Kombo - All Employees").
   • Click on "Continue". Kombo creates a public Hyperfind with this name that includes all active, inactive, and terminated employees the service account can access.
     
     
     
     If a Hyperfind with the same name already exists, please enter a different name, or select the existing Hyperfind from the dropdown instead.
     
     Select an existing Hyperfind
     • Select the Hyperfind from the dropdown list.
     • Please make sure the selected Hyperfind also covers inactive and terminated employees, otherwise those employees will not be synced.
        

4. Finally, click on "Continue" to set up your integration.
    

   Changing the Hyperfind after setup

   You can change which Hyperfind is used for the employee sync at any time after the connection has been set up, without reconnecting:

   • Create or pick a public Hyperfind in UKG Pro WFM (see UKG Pro WFM: How to create & setup Hyperfind) and note its numeric ID.
   • In the integration settings, enter the ID into the "Hyperfind ID for employee sync" field.

   This setting overrides the Hyperfind selected during the connection flow, and the next sync will use it. Please make sure the Hyperfind covers active, inactive, and terminated employees (with the "as of today" date setting), otherwise those employees will not be synced.
    

   Troubleshooting

   If you see the error "The selected Hyperfind returned no employees", pick a different Hyperfind, or check that the service account has an Employee Group covering the employees you want to sync.