Who can use this feature?
Available on:
All Culture Amp subscriptions.
You can import employee data directly from Employment Hero into Culture Amp using a secure, one-way API connection powered by Merge. Merge is a trusted sub-processor that has partnered with Culture Amp to offer more integration options for our customers. Once set up, data will flow through automatically from your HRIS into Culture Amp, ensuring your employee list and demographic information are always up-to-date.
Data Flow: Employee Data flows from Employment Hero into Culture Amp (one-way sync). Changes made in Culture Amp will not sync back to your HRIS.
Choosing Your Integration Method
We offer two primary ways to connect your employee data. The table below briefly outlines both, and should help with the decision on which is the best approach for your organization:
Method | Type of Import | Best For | Key Difference |
Full Integration (API) | Full Employee Import | Organizations seeking real-time, daily automation of all employee data that the API supports. | Data transfer is handled automatically via a secure API connection. Users left off the file with a termination date (End Date) will become former employees instantly upon sync. For users who simply fall off the data without a termination date, they will remain Active in Culture Amp until a manual sync triggered by Support. We strongly recommend ensuring all terminated employees have an end date in the HRIS to guarantee accurate deactivation. |
Partial Employee Import | Organizations that need complete control over file creation or have unique filtering requirements. | You generate a file and securely transfer it to us at scheduled intervals. Users missing from the file are ignored unless you include an end date. |
Sync Your Data with the API
Using this method, employee records flow automatically and securely from Employment Hero to Culture Amp through a dedicated connection.
Access Requirements
To set up the connection, you’ll need:
Access to your Employment Hero instance with the required role (see Permissions below).
Access to Culture Amp with Account Administrator or Employee data administrator permissions.
Important Considerations for the Employment Hero API
Below are some important considerations to keep in mind if planning to use the Employment Hero integration.
Initial Setup Timeframe: Due to field limitations and system complexity, the integration setup could take several days to a few weeks. We recommend involving a technical Employment Hero administrator or somebody familiar with the Employment Hero configuration, and allocating sufficient time and resources for best results.
Employee Exclusion Limitation: Employment Hero does not support an exclusion field via the API. If you need to exclude users, you will need to follow the workaround steps outlined in the Excluding Users (Workaround Required) section.
Employee ID Mapping: The default mapping for Employee ID often results in a blank field in Culture Amp. We recommend chatting with a Culture Amp Support Specialist to confirm the back-end mapping has been configured to pull the Employee Code field from Employment Hero.
Field Limitations: The Employment Hero integration has limited access to custom fields. If a required demographic isn’t available to map, you may need to manage that data directly in Culture Amp through a manual user import. Reply with "Ask a person" in a support conversation to be connected with a Support Specialist to see what options are available.
Terminology Breakdown
When setting up your data mapping, these terms may be helpful for clarifying your data structure:
Term | Also Known As | Definition & Example |
Object | Business Object or Entity | The container or table where the data lives (e.g., employee record). |
Field | Field, Data Field, or Element | The specific piece of data you are tracking (e.g., "Company," "Location," "Job Title"). |
Property/Attribute |
| The rule/configuration of the Field (e.g., "Required," "Data Type"). |
Value |
| The specific data assigned to the employee (e.g., ”Sales Representative”). |
Before You Start: Access and Permissions
Having the correct Employment Hero permissions is essential for a successful connection.
Tip: For the full list of fields and objects accessed by the connector, please refer to the Employment Hero API Reference Guide.
Permission/Role | Permissions Needed in Employment Hero | Rationale |
Required Roles | Employment Hero Administrator role. | Required to authorize the API connection and allow read access to employee and group data. |
Employee Data | Integration Common Model: Employee
API Service user must have view access to these objects:
| This endpoint is the primary source for core employee fields (Name, Email, DOB) and contact details. |
Employment Details | Integration Common Model: Employment
API Service user must have view access to these objects:
| These two endpoints provide essential employment details, including start/termination dates and job title. |
Groups | Integration Common Model: Groups
API Service user must have view access to these objects:
| This endpoint is used to retrieve organizational structure information, such as department and team, for group demographics. |
Step 1: Connect and Authenticate Your Employment Hero Account
Sign in to Culture Amp with an account that has Account Administrator or Employee data administrator access.
Navigate to your Settings > Account > Integrations page.
Select Employment Hero from the list of integrations and click Continue setup.
You will be shown a screen indicating that an Employment Hero Administrator role is required. Click I am an admin.
Click Next to authorize Culture Amp's request to read your Employment Hero employee data.
You will be prompted to log in to connect your Employment Hero account. Click Open window and enter your Employment Hero email address and password to finalize the connection.
Fields Culture Amp has Read Access to
Employees
Employees
Avatar
Date Of Birth
Display Full Name
First Name
Gender
Groups
Last Name
Manager
Marital Status
Mobile Phone Number
Personal Email
Preferred Name
Start Date
Termination Date
Work Email
Groups
Groups
Name
Type
Step 2: Setting Up Demographic Field Mapping
Once you have authenticated with Employment Hero, you will be prompted to map demographic fields you would like to import into Culture Amp.
Note: On your end, you will not be able to delete or edit the field once it has been set up. If you would like to make changes, please contact our Culture Amp Support team.
Demographic Automatic Mapping
The fields listed below are configured to automatically map to the most common, out-of-the-box fields in Employment Hero.
Note: Do not manually map the fields below unless instructed by a specialist. If the data for these core fields is not pulling correctly (especially if Employee ID is blank), please reply with "Ask a Person" in a support conversation to speak with a Product Support Specialist for a back-end custom mapping.
Culture Amp Field (The Destination) | Merge Common Model Field | Employment Hero Endpoint (Data Location) | Notes on Source & Known Quirks |
Email (Unique Identifier) |
|
| This field is critical for matching users. Data is pulled from the primary work email in Employment Hero. |
Employee ID (Unique Identifier) |
|
| The default connection often results in a blank ID. Culture Amp can apply a custom back-end mapping to pull the Employee Code ( |
Name |
|
| The full name is automatically compiled from the first and last name fields in Employment Hero. |
Preferred Name |
|
| Pulled from the preferred name field in Employment Hero. |
Date of Birth |
|
| Pulled from the date of birth field in Employment Hero. |
Start Date |
|
| Pulled from the employee's official start date in their employment history. |
End Date |
|
| Used to mark an employee as Former. Pulled from the official termination date in Employment Hero. |
Manager Email / Manager ID / Manager Name |
|
| Hierarchy data is pulled from the manager object connected to the employee record. We recommend validating your hierarchy using the Manager Email field vs ID. |
Mapping Custom Demographics
If you track additional employee data in Employment Hero that you want to use as demographics in Culture Amp, follow these steps to set up custom mapping.
mapping.
Step 1. Map Fields
Step 1. Map Fields
Click Map Fields.
Step 2. Select the Data Model for Target Field
Step 2. Select the Data Model for Target Field
From the target field dropdown, select Employee.
Step 3. Set Details for the Target Field
Step 3. Set Details for the Target Field
Specify the details for the field you want to target (e.g., Gender).
Step 4. Choose the Matching Field from Employment Hero
Step 4. Choose the Matching Field from Employment Hero
Select the matching field from Employment Hero and click Save.
Step 5. Save Mappings
Step 5. Save Mappings
You can either Save mappings or click the + Field Mapping button to add more.
Tip: If you cannot find a required demographic field during mapping, it may be due to API limitations. You may need to:
Map an alternate custom field that contains similar data.
Manage the demographic directly in Culture Amp via manual imports.
Excluding Users (Workaround Required)
Employment Hero does not support an exclusion field via the API. If you need to exclude users from your sync, you must use Culture Amp’s bulk deactivation feature as a workaround.
Allow the initial sync to import all users from Employment Hero, including those you want to exclude.
In Culture Amp, export a copy of your user list:
Go to Settings > Employee Data > Users > Import & Export > Export
Check the box for Include deactivated users
The export will contain a column labeled Employee Deactivated.
Update the
Employee Deactivatedcolumn in the exported file:Assign
"TRUE"to all users you want to exclude (they will be deactivated).Assign
"FALSE"to users who should remain active.
Save the file and perform a manual partial import:
Go to Settings > Employee Data > Users > Import & Export > Import users > Upload your file > Partial import.
Once complete, deactivated users will remain deactivated and will not be reactivated in future syncs.
Step 3: Activate Integration
After mapping your fields, click Sync and the system will run an initial sync to connect your Employment Hero account details and mappings.
Note: This sync does not import employee data yet.
You will see a "Syncing data" message. This initial sync can take up to 12 hours to complete, depending on the size and complexity of your Employment Hero configuration.
Feel free to navigate away from the page. The process runs in the background.
The "Syncing data" message confirms the connection and mapping setup. Once this first sync completes, you can proceed to import your employee data through another sync.
Note: As part of our commitment to data security, only data relevant to your import and field mappings will be stored.
Step 4: Run Your First Employee Data Sync
Once the initial setup sync is complete, the Integrations page in Culture Amp will update. Follow these steps to run your first employee data import:
Click the Finalise sync button.
Click Get Started.
On the review page, ensure Sync is selected in the "Sync with merge" section (ignore the other options).
Culture Amp will validate the data. If there are no concerns, click Next.
Review the data: Carefully examine the review screen, which shows the number of new employees to be created, existing employees to be updated, and employees to be deactivated. If there are any issues, check the troubleshooting section below or ask our Culture Amp Product Support team for help.
Hit Import Data to pull the employees into Culture Amp.
After the import is complete, click Go to Users to review the new users.
Once these steps are completed, you will see the green "Syncing data" notification appear on the Integrations page. After syncing is complete, you will see the latest sync information, including the date and time of the last sync, and confirmation that your integration is Connected on the Integrations page.
Setup Automated Daily Syncs
By default, auto-syncs are off. We recommend enabling daily syncing to ensure your employee demographics are kept up-to-date.
To enable: Go to Integrations, click on the Off button and toggle Auto-sync On.
To disable: Go to Integrations, click on the On button, then click Turn off auto sync.
Note: Auto-sync won’t run if the Finalise sync step is still displayed. Click Finalise sync to finish setup.
Troubleshooting & FAQs
If the fixes below don't resolve your issue, reply with "Ask a Person" in a support conversation to speak with a Product Support Specialist.
Employment Hero: Integration-Specific Errors
Issue | Cause | Suggested Fix |
Employee ID is Blank for Users | The default setting for the integration does not automatically select the unique Employee Identifier that you use in Employment Hero. This is a technical mapping quirk, even though the data is present in your system. | Contact Support for Custom Mapping. The field most often required is your
|
Workaround for excluding users is required | Employment Hero has limited functionality for custom fields, meaning a custom exclusion field is not available via the API. | Use Culture Amp’s bulk deactivation feature to exclude users. Refer to the Excluding Users (Workaround Required) section for detailed steps. |
Missing Data/403 Errors | The connecting API user lacks required Read Access to the necessary API endpoints. | Verify Permissions: Ensure the user has read access to all required objects ( |
Hierarchy Errors | The person listed as the manager in Employment Hero is not imported to Culture Amp, or the Manager field is mapped to a non-email field. | Check your data: Ensure all managers are included in the employee import file and that the Manager Email field is mapped to a field containing a valid email address. |
Need to Edit/Delete Mappings | Mappings are locked in the Culture Amp platform once set up. | Contact Culture Amp Support: Reply with "Ask a Person" in a support conversation. The change must be made by a specialist, and a full system re-sync may be required to reflect the change. |
General Data Integrity & Import Management
The first step when investigating any data issue is to check the Import Summary Screen for your most recent import.
Go to Settings > Employee Data > Import History.
Select your most recent import to view details.
This screen provides information on the state of your integration, any specific errors, or will prompt you to run a manual sync to identify problems.
Switching From CSV or Other Imports
Switching From CSV or Other Imports
If you are moving from CSV uploads or a different integration, keep the following in mind:
Demographic Consistency: When mapping fields, you must map the data to the exact same demographic field you used historically (e.g., mapping to "TEAM" is different from mapping to "TEAM NAME"). Using an incorrect or slightly different title risks discontinuity in your trended survey results.
Recommended Action: To avoid confusion, we recommend navigating to Settings > Employee Data Demographics and deleting the old, unused demographics after your first successful sync. (This won't impact any previous survey results.)
Handling Duplicate Employees
Handling Duplicate Employees
Culture Amp matches employees based on their Email address. If an employee has a different email in Culture Amp than in Employment Hero, duplicate profiles will be created.
Scenario | Action to Take |
A. Before Changes Are Applied | During the first sync review screen, stop the sync. Update the employee emails in Culture Amp to match those in Employment Hero.
|
B. After Changes Are Applied | To clean up the duplicated profiles:
|
Further Guidance | Check out our dedicated support guide for further information on duplicate employee clean-up. |
Sync Blocked to Protect Employee Privacy
Sync Blocked to Protect Employee Privacy
Your automated daily sync might be blocked if Culture Amp detects a high-risk change for an employee. You will receive an email notification if this occurs.
When It Happens: The sync is blocked if a combination of an employee's Name, Date of Birth, or Email is changed simultaneously.
Purpose: This prevents one employee from accidentally getting access to another employee's private information (like performance reviews).
Fix: If you've intentionally changed the employee's details, you can run a manual sync to push the change through. Go to Settings > Employee Data > Users, click Import data, and select Sync. Culture Amp will guide you through the rest.
Redaction of Sensitive Data
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 reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.
💬 Need help? Just reply with "Ask a Person" in a support conversation to speak with a Product Support Specialist.