Skip to main content
All CollectionsIntegrations
Integrating with Sage HR
Integrating with Sage HR
Roxanne Advincula avatar
Written by Roxanne Advincula
Updated over a week ago

To begin setting up your Sage HR integration, click on the Settings button and then on Integrations.

Next, click Add to SkyPrep under Sage HR. If Sage HR is under the "Disabled Integrations" list, click Configure.

Next, select Link Sage HR.

The first thing you will need to link your Sage HR account is your subdomain.


On your Sage HR account, your subdomain is everything before ""

In the example below the subdomain is example11.

<a href="" target="_blank" rel="nofollow noopener noreferrer"></a>

Copy and paste this into the subdomain field in Skyprep, then hit Submit.

Next you will need your Sage HR API Key.

To find your Sage HR API Key, log in and click on your name on the top right corner, and select Settings in the drop-down menu.

Click on Integrations in the left hand menu, and select API in the drop-down menu.

Copy the API Key.

Next, paste the API into Skyprep.

Set the integration to Enabled and fill in Client Namespace, Username, and Password for your Sage HR account, and designate what user fields you want to use in the Expand Fields area. The expected format for Expand Fields is comma-separated text with no spaces, such as "contacts,employmentstatuses,managername".

Next, set the Time Between API Calls. This sets how quickly the integration can submit API requests which allows you to ensure you stay within your allowed API rate limit.

Termination Date Action lets you decide what happens if a termination date is added to a user's profile in Sage HR. If Reactivate terminated users in the LMS that are no longer terminated in Sage HR is turned on, user will be reactivated if the Termination Date was removed.

Enable Email Notifications on New User Creation will send a welcome email to your users when their accounts are created via the integration.

Remove users from groups they are no longer a part of in Sage HR will unenroll users from Groups they are removed from in Sage HR. This will also unenroll them from any courses and Learning Paths they are enrolled in via that Group.

Deactivate users in the LMS that are no longer in Sage HR will disable removed users, preventing them from being able to log in while retaining all of their training records.

Next, click on the Data Mapping field.

Here you can choose which SkyPrep Property is linked to your Sage HR values. The Primary Value is what will be used first, with Secondary Value being used if the Primary value is blank in a user's profile.

You can add additional SkyPrep Properties by adding additional Custom Labels in your Platform Settings area.

Finally, click on Import Rules. This area allows you to set rules to determine which users are added to your platform. To add a rule, click on Add Rule.

You can then set a rule and specify whether the user is added or skipped if they match the conditions.

Did this answer your question?