Skip to main content
All CollectionsAccount Admin HubIntegrations & APIMerge API
How to Sync HRIS Data From Deel Via the Merge API
How to Sync HRIS Data From Deel Via the Merge API

Guidance on how you can sync HRIS data from Deel using the Merge API

Jessie Walsh avatar
Written by Jessie Walsh
Updated over 4 months ago

What can I learn from this page?

Guidance on how you can sync HRIS data from Deel using the Merge API

Who is this guide for?

Account Admins

This integration is powered by Merge API, a trusted sub-processor who has partnered with Culture Amp to offer more integration options for our customers. We can import data directly from Deel. The setup process is straightforward and can be completed quickly without technical support.

This Integration is Currently in Beta

This is a new HRIS integration that is currently in Beta. Beta means you’re one of the first to try out our latest integration before its full launch. During this phase, we're actively seeking your feedback to refine and improve the integration experience further. While it's fully functional and secure, you may encounter occasional bugs or changes as we fine-tune the experience. Your input is invaluable in shaping the final version, so please don't hesitate to share your thoughts and experiences with us via this survey.

How it Works

  • Employee Data will flow from Deel into Culture Amp. Changes to employee data in Culture Amp will not flow back to Deel.

  • Any employees already in Culture Amp but not imported from Deel will be made inactive as former employees with their End Date set to the date of import.

📌 Note: The default behavior for users left off your HRIS sync file is to set their end date to the import date, categorizing them as former employees. If you prefer that these users are treated as deactivated instead, just reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist and we can adjust the default setting.

Before You Start

Ensure that you have access to the following accounts when setting up the integration:


Step 1: Connect your Deel Account

  1. Sign in to Culture Amp with an account that has Account Administrator access.

  2. Navigate to your Settings > Data Integrations page in the Culture Amp platform.

  3. Select deel. from the list of integrations.

  4. Click Continue setup


Step 2: Setup Deel OAuth Credentials

Follow the prompts to generate your Deel credentials. Click here if you need further help setting up your organisation token. Once done, select Use my API key or access token.

Once entered, you will be prompted to select what data to use. Select Use my Deel data.

You will see CultureAmp’s request to read your Deel employee data. Click Continue.

You will then be asked if you are connecting a Deel sandbox or Production account. Select Production account via the dropdown.

You will then be prompted to enter your organisation token.


Step 3: Setting Up Field Mapping

Once you have authenticated with Deel, you can map fields you would like to import into Culture Amp.

📌 Note: On your end, you will not be able to delete or edit the fields once they've been set-up. If you would like to make changes, please speak with a Product Support Specialist by replying with “Ask a Person” in a Support Conversation

Please note that the below fields will map to their equivalent field in Culture Amp automatically, so you don't need to manually map them. It's important to steer clear of manually mapping these fields to avoid any hiccups with your data:

  • Name

  • Preferred Name

  • Employee Id

  • Email

  • Start Date

  • End Date

  • Date of Birth

  • Manager Id

  • Manager Name

  • Manager Email

To map additional fields, follow these steps:

  1. Select Map fields

2. Select Employee from the target field drop down

3. Set the details for the field you want to target. See the example in the screenshot below:

4. Select the matching field from Deel then click Save.

5. You can Save mappings or click the + Field mapping icon to add more.


Step 4: Active Integration

Once everything's set up, you'll see the integration screen. Data syncs happen automatically, but the first one might take a few hours; during this time, you won’t be able to sync data into Culture Amp. Feel free to navigate away from the page, as data syncing will continue to happen in the background. You can return to check on the progress later. After that, you can manually sync data whenever you need to.

Note: As part of our commitment to data security, only data relevant to your import and field mappings will be stored.


Optional - Choose the Type of People to Sync

If you want to exclude specific employees when importing your employee data via the Merge API, you'll need to specify those employees in your HRIS system. You can do this by creating a custom field or using an existing field in your HRIS.

For more information on excluding employees from imports, check out our guide on Excluding Specific Employees from Data Imports via the Merge API. This guide provides step-by-step instructions and best practices.


Step 5: Sync Data

After connecting Deel and Culture Amp, perform a manual sync. Click Finalise sync to begin:

Next:

  1. Click Get Started.

  2. At the top of the page, in the Sync with merge section, select Sync (ignore the Select Import and Import your user data sections as they are not applicable for an integrated sync).

  3. Culture Amp will validate the data. If there are no concerns, select Next.

  4. Review the data. If there are any issues, check the troubleshooting section below or reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

  5. Hit Import Data to import the employees into Culture Amp.

  6. After importing, click Go to Users to review the new users.

1. Once these steps are completed, you will see the "Syncing data" notification appear on the Data Integrations page.

2. After syncing is complete, you will see the last sync information and an active Deel integration. To perform another manual sync, click Sync and follow steps 1-6 as above.

Note: If you leave the "Finalise sync" message on the "Data Integrations" page, the autosync feature will not work. You must click the "Finalise sync" button to enable autosync.


Setup Automated Data Syncs

You can set up daily auto-syncing of your employee data with CultureAmp. Auto-syncs help ensure your data is always up to date.

By default, auto-syncs are Off when you set up a new Merge Integration.

To switch on auto-syncs:

  1. From the Data Integrations page, click on the Off button.

  2. A pop-up will appear. Confirm by clicking Turn on auto sync.

  3. Once enabled, your data will sync daily during Merge's next cycle.

To turn off auto-syncing:

  1. From the Data Integrations page, click the On button.

  2. A pop-up will appear. Confirm by clicking Turn off auto sync.

  3. Your auto-sync will be turned off.


Troubleshooting Integration Issues

To explore troubleshooting for common user import errors not addressed below, please refer to our guidance here.

For any hierarchy errors such as your import being blocked because there are employees assigned to managers that are not in your employee list, check out our support guide for troubleshooting assistance.

For further troubleshooting tips, check out our guidance below:

Switching from CSV Uploads to Integration

If you already have existing data in Culture Amp as a result of doing CSV uploads or using a different integration, then there are a few things to pay attention to:

  • When doing your first sync via the Deel integration, you could see errors related to matching employees. Please review the troubleshooting information in the Duplicate Employees section below.

  • When doing field mapping during the integration setup it is very important construct target demographics/fields accurately. For example: If you have historically used a demographic “TEAM” it is critical to map your data to that specific demographic. If you map to a field title that is similar but not exact e.g. “TEAM NAME” there is a risk that you will not see continuity in your data over time in the platform. This is possible to remediate but may initially be confusing if this error occurs. We would recommend keeping this in mind if you trend results in surveys for demographic groups over time. To avoid confusion from users about which demographic to use, we would recommend navigating to the Settings > Account Demographics page and deleting the old demographics after your first sync (this will not impact any previous survey results or comparisons).

Duplicate Employees in Culture Amp

Culture Amp will match employees in Deel to employees in Culture Amp based on the employees email address. If the same employee has a different email address in Culture Amp and Deel, duplicate employee profiles will be created in Culture Amp. Here is how to reconcile the duplicates:

  • Before Changes are Applied:

During the first sync, you'll get feedback on all employees to be created, updated, or deactivated on the Review screen. At this point, ideally, you'd stop the sync and update employee emails in Culture Amp to match those in Deel

To update emails in Culture Amp:

  1. Go to the Users page.

  2. Click on the name of the employee you want to update.

  3. Update their email.

  4. Click Save and Exit to update.

  5. Repeat for all duplicated employees.

  6. Then, try the integration sync again.

Check out our support guide for further information.

  • After Changes are Applied:

If you didn't handle the duplicates during the first sync and duplicate employee profiles were created, you can clean the data using the following steps:

  1. Deactivate the newest employee profile and remove their email (you'll need to assign a fake ID/email to Save).

  2. Update the original user profile to match emails in Deel. This keeps the history on the existing employee record.

Check out our support guide for further information.

Sync Blocked to Protect Employee Privacy

Your automated daily sync might be blocked if Culture Amp suspects that one of your employees may have had their details mixed up with another. You will receive a notification of this via email.

If a combination of an employee's Name, Date of Birth, or Email is changed, the sync will be blocked. This is to prevent an employee from accidentally getting access to another employee's private information, such as performance reviews.

If you've intentionally changed the employee's details, you can run a manual sync to push through the change. Simply click Import data from the Settings > Users page and select Sync. Culture Amp will guide you through the rest.

Redaction of Sensitive Data

As part of this integration, Culture Amp has the ability to redact sensitive data at your request. If you need any fields to be disabled/redacted for your account please speak with a Product Support Specialist by replying with “Ask a Person” in a Support Conversation. They will assist you in actioning this redaction.

Investigating and Resolving any Data Issues

Once the first integration has been performed and the integration history has been created, the first step when investigating data issues is to check the Import Summary Screen for your most recent import. This will provide information about the state of your integration.

To find this information, go to Account Administration > Import History and select your most recent import.

If there was a problem with your last import, you will either be able to view errors on this page or you will be prompted to run a manual sync to identify any problems.


💬 Need help? Just reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

Did this answer your question?