Integrating your UKG Ready environment with the CypherWorx LCMS allows for user management, making it simpler to manage your employees. This article outlines the steps required to set up the integration and important considerations before getting started.
Please note that UKG may have additional costs associated with integration. You may need to reach out to them directly for details. Additionally, there is a cost on our end to facilitate the integration. If you’re interested in proceeding, please contact us to discuss next steps.
TABLE OF CONTENTS
What's Included?
This integration automatically creates user accounts based on a roster shared with us.
By default, we use the work email as the primary identifier. If your organization uses a different field (such as a personal email), please let us know so we can adjust accordingly.
The following fields are included:
| Field | Example |
|---|---|
| COST CENTER Department | Human Resources |
| COST CENTER Location | Albany |
| COST CENTER Position | HR Admin |
| display full name | John Smith |
| employee number | 1234 |
| employment job title | Human Resources Admin |
| employment status | ACTIVE |
| first name | John |
| id | 01234567-1234-123a-1234-1234567a89b0 |
| last name | Smith |
| manager display full name | Jane Doe |
| middle name | Lee |
| mobile phone number | 555-555-5555 |
| modified at | 2025-06-11T07:02:38Z |
| personal email | johnsmith@gmail.com |
| start date | 11/20/2024 |
| username | JohnSmith |
| work email | john.smith@company.com |
| work location city | Albany |
| work location country | USA |
| work location postal code | 12345 |
| work location state | NY |
| work location street 1 | 123 Main Street |
How It Works?
We use Bindbee, an integration organization, to connect CypherWorx with your UKG Ready system. This integration enables secure, automated syncing of key employee data between platforms, saving time and reducing manual entry.
To get started, there are a few setup steps CypherWorx is required to complete first, followed by configuration on your side to complete the connection. This ensures your employee data is accurately and securely shared with the CypherWorx LMS.
We’ve adapted the original Bindbee instructions to make setup easier for you, but if you’d like to reference the full documentation, you can view the original article here.
Your Setup
Once CypherWorx has completed the necessary configuration on our end, you will need to complete some tasks on your end to finalize the integration.
Setup Link
1. We will provide you with a "magic link" to initiate the setup. This link will guide you through the required configurations within your UKG Ready site to complete the integration.
Click on the link we provide you. It will look similar to a URL as shown below:
https://link.bindbee.dev/letters-and-numbers
2. You will be asked to allow read and write access to your environment. Select Allow and Continue.
Retrieve Your Domain Name
You will be asked to provide your UKG Ready domain name. To retrieve it:
3. Navigate to the UKG Ready website
4. Click on your browser's address bar
5. Copy the text after "https://" and before "ta"
6. Paste your domain in the prompt. Click Connect.
Company Short Name
You will then be asked to provide your UKG Ready company short name.
7. Navigate to Settings > Global Setup > Company Setup from the menu on the top left.
8. Click on the Company Info tab.
9. Scroll to the Company Address section and copy the Company Short Name.
10. Paste the Company Short Name in the prompt. Click Connect.
Retrieve the UKG Ready API Key
The API key is used to securely authenticate your UKG Ready account and allow authorized data sharing with our system.
11. In your UKG Ready site, navigate to Settings > Global Setup > Company Setup from the top left menu. This will open the company settings.
12. Click on the Login Config tab.
13. Scroll to the API Keys section.
13a. If there is no API Key, click on Generate to create an API Key. Then please continue to Step 14.
13b. If there is an API Key already available, DO NOT click on Generate. Then please continue to Step 15.
14. A prompt will appear. Click Yes to generate a new API Key.
15. Click on the eye symbol to view the API Key. Copy the key.
16. Paste the key into the provided prompt.
Retrieve UKG Ready API User Credentials
17. In your UKG Ready site, navigate to Settings > Profiles/Policies > Security.
18. A new security profiles needs to be created. Click on New Security Profile and enter in an appropriate name, such as "ukg_ready_profile_1".
19. Provide the appropriate API access by selecting the following options under the Global tab in the right column.
20. Under Global Setup:
- Give View access to Company EINs
- Give View access to Cost Center Definitions
- Give View access to Leave of Absence Custom Fields Definitions.
21. Under Object Lists:
- Give View access to Company EINs
- Give View access to Cost Centers
- Give View access to Leave of Absence Categories
- Give View access to Pay Period Profile.
21. Under the Payroll tab:
- Under Payrolls, click Create/Edit Payroll.
- Under Pay Statements, click View/Edit/Add.
- Click Payroll Prep Process.
22. Under the HR tab, locate the Employee section.
- Give View access to Base Compensation.
- Give View access to Benefit Management (Plans).
- Give View access to Cost Centers.
- Give View access to Total Compensation.
23. Under Leave of Absence Management, select Manage Requests.
24. Under the Modules tab, go to Rest API Resources.
- Check View for Employee Demographics.
- Check View for Employee HR Custom Fields.
- Check View for Employee Pay Information.
- Check View for Employee Profiles.
- Check View for Employees.
Then click Save.
Create Service Account
Service accounts are essential for managing an organization’s data and resources, especially when working with integrations or APIs. Unlike employee accounts, service accounts are not subject to password rotation policies or single sign-on (SSO) requirements.
Important: Always use a service account for this step. If an employee account is used, the integration may break if the user changes their password or leaves the company.
25. Navigate to Settings > Global Setup > Company Setup.
26. Click on Edit Tabs.
27. Under Available Windows, select Service Accounts and drag it to the Top section. Then click Save.
28. Go to Login Config and click on Add Service Account.
29. Create a new service account with appropriate credentials.
- Username: Enter the username you created earlier, such as "ukg_ready_service_acc"
- Password: Enter any password
- External ID: Leave blank
- Security Profile: Click on the magnifying glass, then select the security profile you created earlier, such as "ukg_ready_profile_1"
30. Under Account Access > Account Groups, click the magnifying glass and select All Company Employees, and click on Select.
31. Add your credentials in the provided section.
- Username: ukg_ready_service_acc
- Password: Your password
32. Click on Connect.
You are now successfully connected. Please then notify a CypherWorx team member and we will test the integration.