> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.superpath.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to Connect and Configure Employment Hero

# How to Connect and Configure Employment Hero

The SuperPath Employment Hero integration is a great way to connect your Employment Hero system to SuperPath to keep your people and teams in sync.  

> **Already connected to Employment Hero?** Employment Hero is changing the way apps sign in from **14 September 2026**, and existing connections need to be reconnected before then. Follow [How to Reconnect Employment Hero and Turn On Two-Way Sync](https://help.superpath.io/en/article/how-to-reconnect-employment-hero-and-turn-on-two-way-sync-1qo0xb9/) instead of this article.

```
IMPORTANT: In order to connect your Employment Hero account to SuperPath please ensure you are on the correct Employment Hero plan that allows API access.  
```

Once you have confirmed you have the correct Employment Hero plan.  Follow the below steps to connect:

### STEP 1:  Configure the SuperPath App in Employment Hero

Navigate to the Developer Portal in Employment Hero.  This can normally be found by clicking in your Avatar in the top right corner.  In the menu select "Developer Portal" (see image below)

![](https://storage.crisp.chat/users/helpdesk/website/-/c/0/6/4/c0645e580ffc0800/image_18ukc33.png)

From here click **Add Application** and enter the following details and scope

> **Not sure which region your account is in?** Look at the address you sign in to SuperPath at: **app.superpath.io** is the US region, **app-au.superpath.io** is the AU region and **app-eu.superpath.io** is the EU region. Use the Redirect URL below and the webhook URL in Step 2 for that region. A URL for a different region will not work. If you sign in on your own custom domain, contact our support team to confirm your region.

**Name:**  SuperPath
**RedirectURL:**  
* For SuperPath US Region - [https://app.superpath.io/auth/employment-hero](https://app.superpath.io/auth/employment-hero)
* For SuperPath AU Region - [https://app-au.superpath.io/auth/employment-hero](https://app-au.superpath.io/auth/employment-hero)
* For SuperPath EU Region - [https://app-eu.superpath.io/auth/employment-hero](https://app-eu.superpath.io/auth/employment-hero)
**Scopes:**
* certifications:list
* employees_certifications:list
* employee_custom_fields:list
* employees:list (both)
* certifications:show
* employees:show
* teams:list
* teams:employees:list
* organisations:list
* organisations:show

**Plus these four Certification bundles**, which Employment Hero presents in the scope picker as bundles rather than individual permissions:
* Certification - Read
* Certification - Create
* Certification - Update
* Certification - Delete

> **Important:** Select every scope in the list above, including all four Certification bundles. They are only used if you want SuperPath to write completed training back into Employment Hero, but Employment Hero **does not allow scopes to be added to an app after it has been created** — so if you leave them out and later want two-way sync, you'll have to create a whole new app and reconnect. **Certification - Read** is the easiest one to skip by mistake: as well as reading certifications it carries the permission SuperPath needs to confirm a write has finished, so writes start but never complete without it.

One you configure these above and create the app it will give you a ClientID and Client Secret.  

```
It is important you take a copy of these credentials as you will need to use them when connecting Employment Hero in SuperPath.  You will also need the company name which can be located here - https://secure.employmenthero.com/account
```

One you have configured the application and make a copy of the ClientId, Client Secret and the Company Name, it's time to configure the WebHooks

### STEP 2:  Setup Webhooks in Employment Hero
You will also need to set up webhooks so people changes can be synced into SuperPath.  In the same development portal you can click Webhooks in the left hand menu, the click "Add Webhook".

Add the following webhook with the information below.  It's important that in the API URL you replace the account ID with your real account id.  This can be found in the General Settings in SuperPath.

**Name:** SuperPath

**URL:** 
* For SuperPath US Region use https://integrations.superpath.io/public/integrations/webhooks/**accountId***/employment-hero*
* For SuperPath AU Region use https://integrations-au.superpath.io/public/integrations/webhooks/**accountId***/employment-hero*
* For SuperPath EU Region use https://integrations-eu.superpath.io/public/integrations/webhooks/**accountId***/employment-hero*

**Events:**
* employee_created
* employee_updated
* employee_onboarded
* employee_offboarding

Once the webhook is saved, copy its **signing secret** as well. You can paste this into the **Webhook Secret** field when you configure the integration in SuperPath, and SuperPath will use it to confirm that incoming webhooks genuinely came from Employment Hero. It's optional, but recommended.

`employee_offboarding` is the only event Employment Hero sends when someone leaves. With it selected, SuperPath disables the person's account as soon as Employment Hero records their termination date. Leave it out and a departing employee keeps their SuperPath login until an admin runs **Trigger Full Sync**.

### STEP 3:  Setup Employment Hero Integration in SuperPath
The final step is to configure the Employment Hero integration in SuperPath.  Follow the steps below to configure.

1. Navigate to Integration Settings 
2. Select the Employment Hero Integration and click **Connect**
3. Select the user creation option.  (see below)
4. Now enter the Company Name, Client Id and Client Secret that you saved from Step 1.  If you copied the webhook signing secret in Step 2, paste it into **Webhook Secret** too
5. Click **Connect Employment Hero**
6. Follow the prompts to authorise the application in Employment Hero

Once you are successfully completed you can run the Sync Teams or Trigger Full Sync to start to import users (based on selection).

### Optional:  Two-way sync

Alongside the user creation options you'll find three optional settings which write completed training from SuperPath back onto the employee's record in Employment Hero, under their **Certifications**:

* **Sync learning pathways** - a completed Pathway, recorded as type **Training**
* **Sync learning assignments** - completed Content, Events, Forms and individual Pathway steps, also type **Training**
* **Sync certificates** - an earned Certificate, recorded as type **Qualification** with its expiry date

All three are off by default, and they need the four Certification bundles selected on your Employment Hero app (see Step 1). Learning only syncs if the item itself has **Sync with HRIS** enabled, and only when the person met any pass mark - failed learning is never written across.

Once you've switched a toggle on, use **Learning Resync** under **Additional actions** to bring across everything that was already completed beforehand.  It's safe to run more than once.

See [How to Reconnect Employment Hero and Turn On Two-Way Sync](https://help.superpath.io/en/article/how-to-reconnect-employment-hero-and-turn-on-two-way-sync-1qo0xb9/) for the full detail.

###### User Creation Options
SuperPath offers seven options for how to create users when connecting a HRIS platform
* **Manual** - In this option users will NOT be created and will have to be created or invited manually.  Once added the user records will be kept in sync through updates from Employment Hero
* **Invite Users** - In this option users will be invited to the platform when triggered from Employment Hero.  Users will only appear in SuperPath once they have accepted their invite.  This is the option to use when wanting to use Google or MSFT SSO options
* **Create with Password** - In this option the user will be created in SuperPath with a password.  The user will not be notified.  You can send a welcome email using the Send Welcome button in the People list which will send them their password.  Alternatively they can use the forgotten password flow.
* **Create with Magic Link** - In this option the user will be created in SuperPath with a magic link.  The user will not be notified unless Send Welcome Email is activated.  You can also send a welcome email using the Send Welcome button in the People list.  This user will be able to access SuperPath using a magic link - https://help.superpath.io/en/article/how-to-login-using-magic-link-1ghozvh/
* **Create with Google** - In this option the user will be created in SuperPath and marked to authenticate with Google.  The user MUST authenticate to SuperPath with the Google account matching that email.  The user will not be notified unless Send Welcome Email is activated.  You can also send a welcome email using the Send Welcome button in the People list.  
* **Create with Microsoft** - In this option the user will be created in SuperPath and marked to authenticate with Microsoft.  The user MUST authenticate to SuperPath with the Microsoft account matching that email.  The user will not be notified unless Send Welcome Email is activated.  You can also send a welcome email using the Send Welcome button in the People list.  
* **Create with SAML** - In this option the user will be created in SuperPath and marked to authenticate with SAML.  The user MUST authenticate to SuperPath with the SAML configuration that has been setup within SuperPath - https://help.superpath.io/en/article/how-to-connect-saml-sso-1nf8n4q/

###### Company user creation
If your workforce is a mix of office staff on a company email address and contractors or casuals on personal addresses, you can set a second authentication type that applies only to your company email domain.  Set **Company user creation** to the method you want for your company staff, enter your domain in **Company email domain**, and everyone else keeps the option you chose above.  A company domain match takes priority over every other option, including Manual and Invite Users.  See [How to Set a Second Authentication Type for Company Staff](https://help.superpath.io/en/article/how-to-set-a-second-authentication-type-for-company-staff-hp1o58/).