Navigating integrations in MyHR
How to navigate the integrations space in the MyHR platform
Contents
- Overview
- Accessing and managing integrations
- Supported integrations
- Integration settings
- Using the manage tab
- Viewing profiles
- Linking and unlinking profiles
- Managing errors
Overview
This article provides a comprehensive guide to setting up and using the integrations section of the MyHR platform.
It details how to navigate to and within, with key how-to's to view, manage and update your employee's and ultimately successfully integrate your third-party software with MyHR.
Accessing and managing integrations
To access the Integrations area, click the Settings (cog icon) in the top-right corner, select Settings, and then click the Integrations tab. From here, you can select 'Get Started' for a new connection or 'Manage' to view an existing one.
Access permissions
Access to the integrations list and the ability to make changes are determined by your user role and management permissions:
| User Role | Access level | Capability |
| Owner | Full access | Can view the people list, manage settings, and edit all profiles. |
| Manager (with Integrations permission & direct reports) | Restricted access | Can view the people list and edit profiles for those they manage. |
| Manager (with Integrations permission but no direct reports) | View only | Can view the people list but cannot edit profile details. |
Supported integrations
-
Australia: CloudPayroll, MyHR Payroll, Xero.
-
New Zealand: iPayroll, Payhero, Xero.
-
Customisable (via Zapier): Zapier, Custom Payroll, and JobAdder.
Integration settings
Customise how MyHR interacts with your chosen platform:
-
Payroll administrator: Nominate a contact to receive all integration-related notifications and updates.
-
Sync controls: Toggle whether employee data is automatically sent to your integration.
-
Leave balance mapping: Map leave types to specific roles and control visibility (e.g., Management only vs. Self-Service).
-
Platform-specific tools:
-
iPayroll/CloudPayroll: Map User-Defined Groups and Cost Centres.Set your default, so when any new employee's in MyHR are added or linked to Cloud/iPayroll, their User Defined Groups and Cost Centres settings can be sent over too.
-
Xero: This section will show you the name of the organisation/ account/ tenant you have decided to give connect to MyHR. The name will display there and you can always correct this by disconnecting and reconnecting via the settings page
-
PayHero: Login to your PayHero account and copy the API key. Paste it into the MyHR integration settings section and authorise your account
-
Zapier: Generate, view and copy the API key from MyHR and put it into Zapier/JobAdder. You will see an expiry date and a button to regenerate if it has expired. Once successful, it will show as connected in MyHR.
-
Using the manage tab in your integration
The manage tab is the center of your integration. In this area, you will see the list of employee's in MyHR and your payroll and the status of integration.
Data refresh
View the last time payroll data was pulled into MyHR. Use the Refresh button to manually pull the latest information from your payroll system at any time.
People listing
The listing allows you to see the status of every profile at a glance. You can identify the record type by the avatar: a letter represents a MyHR profile, while a logo represents a Payroll profile.
Person column
- Has the person’s name
- Display’s the ID of the person (either MyHR or Payroll)
Sync status column
- Leave sync status will be blank if no linking done between MyHR or payroll
- Once linking is successful, it will change this status to active
- If linked successfully but some leave mapping needs to be done, it will show as inactive
Status column
- Not linked = The profile exists in one system but isn't connected to the other.
- Action required = A sync error has occurred or data needs updating.
- Connected = The profiles are successfully linked.
- Excluded = The user has been manually excluded from your integration.
Filter, sort and search
To make it easier for you to find the people you need in your integration list, you can easily filter by integration status or leave sync status, sort the table by alphabetical order or status and quick search.
View MyHR or Payroll profiles if linked or unlinked
To view a specific record, select the ellipsis menu (..) next to any name in your integration list and choose 'View profile'. How the data is displayed depends on whether the profiles are connected.
Unlinked profiles
If a profile is not yet linked, you will see a singular view containing the employee details available specifically in that system (either MyHR or your payroll software).
Linked Profiles
When profiles are successfully connected, MyHR becomes the primary view to ensure data consistency.
-
Latest details: The profile will display the most up-to-date information stored in MyHR.
-
Payroll indicator: A visual tag containing the payroll provider's name and the employee's ID will appear under the person’s name.
-
Side-by-Side comparison: Click the payroll indicator to open a dual view, allowing you to compare MyHR and payroll records side-by-side to ensure everything matches perfectly.
Linking and unlinking profiles
Use the ellipsis menu (..) within the manage tab to link existing profiles between MyHR and your payroll software.
How to link profiles
Depending on which profile you choose to start from, select the appropriate option:
-
Link to an existing payroll profile: Choose this to connect a selected MyHR profile to an profile already in payroll.
-
Link to an existing MyHR person: Choose this to connect a payroll profile to a profile already in MyHR.
Matching and searching
Once selected, a side panel will appear to help you find the right profile:
-
Smart recommendations: If a similar name is detected, a recommended banner will highlight the best match.
-
Manual search: If no match is found, you can manually search for the correct person by name.
Compare and confirm
Click 'View details' to open the comparison screen. This view highlights any data discrepancies between the two systems, ensuring your records are accurate before you finalise the link.
You can complete the connection directly from this screen or return to the side panel to finish.
How to unlink profiles
If you need to disconnect a profile from your payroll software, you can do so quickly through the manage tab.
-
Locate the person you wish to disconnect and select the ellipsis menu (..).
-
Select Unlink.
-
A confirmation modal will appear to ensure you wish to proceed.
-
Once confirmed, the link between the MyHR profile and the payroll record will be removed.
Managing errors
If an issue occurs when automatically sending a person to payroll (after an IEA is signed) or during a manual sync, the integration status will update to 'Action Required.
Identifying the issue
To resolve a sync error, look for the following indicators within the person's profile.
-
Error banner: A banner at the top of the profile provides specific details regarding the connection or data issue.
-
Status chips: You will see an "Action Required" chip next to the specific sections that require attention.
How to fix and re-sync
You can correct most issues directly within the profile:
-
Editable fields: You can update Personal details and financial information.
-
Read-only fields: Please note that employment information remains read-only.
-
Save & sync: Once you have updated the necessary information, click 'Save & Sync'. This will trigger a new attempt to push the data to payroll.
-
Successful sync: If the update is successful, the status will change to Connected, and the linked payroll profile will be visible.
-
Persistent issues: If the error remains, the status will stay as Action required, and the banner will update to show any remaining or new problems.
Disconnecting an integration
You now have the ability to disconnect any payroll integration directly from your settings. While we recommend keeping your systems connected to ensure data accuracy, this feature provides you with full control over your platform connections.
How to Disconnect
-
Navigate to the Settings tab within your integration.
-
Choose the option to Disconnect.
-
A confirmation pop-up will appear. Review the details carefully before confirming to finalise the disconnection.
Once disconnected, data will no longer sync between MyHR and your payroll software until the connection is re-established.
Support Options
If you need more help, our HR teams are always here for you!
If you have questions, message the MyHR team via the Ask Us chat feature or call us on:
NZ - 0800 69 47 69 (0800 MY HR NZ) or +64 9 887 3345
AU - 02 7908 2240
CA - 1 855 694 7224