All Collections
Sage HR
How to Set Up Frankli's Sage HR Integration
How to Set Up Frankli's Sage HR Integration

Learn how to synchronise your people in Frankli and Sage HR

Updated over a week ago

It's possible to synchronise your team's information across Sage HR and Frankli using Frankli's Sage HR integration. Here's what you need to know to get started.

Before you Begin

Enabling Sage HR API access

In order to set up the integration, you need to enable API access in Sage HR. To do this, log in to Sage HR with your Admin account, then select Settings, then Integrations, then API.

Requesting your API Credentials

To set up the Sage HR integration, we need the following details;

  • Your Sage HR Company ID. This is visible in your Sage HR URL, which should follow this format; https://<company_id>

  • Your Sage HR API Key. You can view this by logging into Sage HR with your Admin account and selecting Settings, then Integrations, then API.

Create a Backup File for your People

We recommend that you follow this guide to create an Excel backup file for your people, so you can restore them later if any information is incorrect after the first sync with Sage HR.

Setting up the Integration

To get started, select Admin, then Integrations, then Sage HR. If you don't see Sage HR listed in the integrations list, please contact us via Intercom so we can enable this option for you.

After selecting Sage HR, you'll be presented with the following screen to help you begin the setup process. Select Set up Sage HR.

You now need to add the information we mentioned earlier, which can be found by logging into Sage HR as an Admin.

Once all the information has been added, select Complete Set Up. We will then verify your credentials and connect to Sage HR's API. If everything is in order, you'll be able to complete the setup.

Running your First Manual Sync

After completing the setup, you'll be prompted to start your first manual sync with Sage HR. This process will pull your people's data from Sage HR and synchronise it with Frankli. The following attributes are kept in sync with Sage HR:

  • First Name

  • Last Name

  • Email

  • Manager

  • Department

  • Role

Through automatic syncing, any new joiners who are added to Sage HR will be created in Frankli. Likewise, people who are removed from Sage HR will be archived in Frankli.

To start your first manual sync, simply select the Rotating Arrows icon below. If you wish to run another manual sync in future, you can use the same button.

The manual sync may take a few minutes, depending on the size of your company, but you'll be informed via notification in Frankli when it has finished syncing. You don't need to stay on the integration page for this part, you can carry on with other tasks in Frankli.

Monitoring your Integration

Toggling the Automatic Sync Off or On

After running your first manual sync, the automatic sync is turned on by default and will update with any changes to your teams every 15 minutes.

If you encounter any issues with the integration, you may wish to pause the automatic sync until you resolve the issues. To do this, simply select the Pause icon next to the manual sync icon below.

Note: While automatic sync is disabled, you can still trigger a manual sync to help resolve any issues.

Reviewing and Resolving Synchronisation Issues

Sometimes a piece of data that is required for synchronisation may be missing or invalid. In these cases, we will skip the employee, and log this as an issue for you to review. You will also be notified in Frankli when issues like these occur.

Did this answer your question?