Skip to main content
How to sync your HRIS data using our Merge API

An overview of our integration to your HRIS using our preferred intermediary Merge

Updated over 2 months ago

📌 If your HRIS isn't listed below, or if you prefer a native API integration instead of using Merge, please reach out to us. We are more than happy to collaborate with you to deliver a custom native API integration that meets your specific needs

Overview:

Integrate your HRIS data with People Insight using the Merge API to ensure a seamless flow of employee data.

Prerequisites

Before starting, we will need work our way through these prerequisites together over a few sessions:

HRIS Admin Privileges
You must have HRIS admin privileges to configure the integration. This ensures you have the necessary access to manage and approve data sharing between your HR system and People Insight.

Common Fields
The integration with Merge requires a broad set of fields for data sharing. These fields enable access to essential employee data, ensuring seamless functionality and insights through the integration. See below for the full list.

Limiting Data Sharing
While the integration requires a broad range of fields, you can limit the data shared based on your organisation’s needs. This provides flexibility and control over which data points are included, helping maintain privacy and compliance with your internal policies.

Consulting on Data Fields
In consultation with us, your team should carefully consider what data fields to send regularly. The more data that can be sent via the integration, the better. While we can supplement missing data manually via Excel/CSV for each survey, this is a manual process. Automating as much as possible is recommended for efficiency.

Authentication & Permissions
We recommend the following steps to securely provide access to your HRIS:

  • Create a user account in your HRIS specifically for the integration. This account should be used solely to provide access to your data.

  • Modify access permissions for the user account to only allow visibility of the HRIS data fields you want to share. The process will vary depending on your HRIS; please contact your HRIS support for more information.

  • Choose "Read-only" access to ensure the user can only view data without making changes.

  • Use the new user account details to authenticate with Merge on our platform.

Following these steps ensures that only the data you have chosen to share with Merge and People Insight is accessible. Choosing read-only access also maintains the integrity and security of your data.

Authorisation (API or credentials)
The integration provides flexibility by allowing you to authenticate using either an API key generated by the user profile set up in step 4 or by entering a username and password for the newly created user. Both methods—API key or username/password—are equally secure, ensuring that necessary data can be accessed for analysis and reporting without compromising your main admin credentials.

📌 Neither People Insight or Merge store any of your authentication credentials, the authentication process allows you to securely give us permissions to read your data without us having access to your credentials

Fields we accept

These are the field we can accept, those with * are mandatory.

  • Address Line 1

  • Address Line 2

  • Company

  • Country

  • County

  • Date of Birth

  • Employment Details

  • Employment Status

  • Employee Number *

  • Ethnicity

  • First Name *

  • Full Name Display

  • Gender

  • Group Memberships

  • Hire Date

  • Location Type

  • Manager

  • Marital Status

  • Mobile Phone Number

  • Name

  • National Insurance Number (NIN)

  • Parent Group

  • Personal Email

  • Phone Number

  • Postcode

  • Preferred Name

  • Remote Creation Date

  • Start Date

  • Surname *

  • Team

  • Termination Date

  • Town/City

  • Type

  • Username

  • Work Email *

  • Work Location

When the prerequisites are done, the step-by-step integration

  1. Request an invitation:

    • Ask your People Insight contact to invite you to connect your HRIS.

  2. Admin access:

    • The People Insight admin will ensure you have admin rights. If not, they will grant you access.

  3. Invitation email:

    • You’ll receive an email inviting you to sync your HRIS via the Merge platform.

  4. Log in:

  5. Merge integration:

    • Click on the Merge integration link.

  6. Field verification:

    • Review the requested data fields for the integration.

  7. Enter credentials:

    • Enter your HRIS admin credentials and save.

  8. Sync process:

    • This triggers the sync between your HRIS, Merge, and People Insight.

  9. Data handling:

    • All data remains within the EU, and you’ll receive documentation on data sub-processors.

  10. Manual mapping:

    • People Insight will manually map your HRIS data to their platform.

  11. Co-browsing support:

    • Co-browsing support is available if needed during the setup process.

After completing these steps, your HRIS will be successfully integrated with People Insight.

Supported HRIS

7shifts, ADP Workforce Now, AlexisHR, AllianceHCM, Altera Payroll, BambooHR, Breathe, Ceridian, Cezanne HR, Charlie, ChartHop, ClayHR, Dayforce, Deel, Employment Hero, Factorial, Freshteam, Gusto, Hailey HR, Hibob, HR Cloud, HR Partner, Humaans, Humi, Insperity Premier, IntelliHR, IRIS Cascade, Justworks, Kallidus, Namely, Oracle, Paycor, Paylocity, PeopleSoft, Personio, Rippling, SAP SuccessFactors, TriNet, Ultimate Software (UltiPro), UKG Pro, Workday, Xero, Zenefits, Zoho People.

Did this answer your question?