> ## Documentation Index
> Fetch the complete documentation index at: https://support.visualcare.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# Employment Hero integration

> How to connect Visualcare to Employment Hero for syncing worker data, compliance items, and leave

Visualcare integrates with Employment Hero HR to sync worker data, compliance certificates, and leave. Once connected, data syncs from Employment Hero to Visualcare once per day at approximately 2am ACST.

<Note>This is separate from the [KeyPay integration](/integrations/keypay) used for timesheet and kilometre exports.</Note>

Some steps need the Visualcare team to enter credentials on the back end, so you share certain details securely during the process.

## What you'll need

* An active Employment Hero account with admin access
* Workers already created in both Visualcare and Employment Hero
* Admin access to Visualcare

## What syncs once connected

### Compliance and leave

* **Compliance (certificates):** Active and Approved certificates in Employment Hero sync to worker compliance items in Visualcare daily
* **Leave:** leave sync is not enabled by default. If you need leave from Employment Hero to flow into Visualcare, let your Implementation Consultant know and the team enables it for you

### Worker data

The following fields sync from Employment Hero to Visualcare daily:

| Visualcare field | Employment Hero field |
| ---------------- | --------------------- |
| First Name       | First Name            |
| Last Name        | Last Name             |
| Sex              | Gender                |
| DOB              | DOB                   |
| Phone 1          | Personal Mobile       |
| Phone 2          | Home Phone            |
| Start Date       | Start Date            |
| End Date         | Termination Date      |
| Marital          | Marital               |
| Accounting Code  | External Id           |
| Preferred Name   | Known As              |
| Case Manager     | Primary Manager       |

<Note>
  Visualcare matches workers by comparing the **Company Email** in Employment Hero with the **Email** on the worker profile in Visualcare. Make sure these match for each worker you want to sync. Case Manager only syncs if the Primary Manager's email in Employment Hero matches a user's username in Visualcare.
</Note>

## Part 1: Create an application in Employment Hero

Create an API application in Employment Hero's Developer Portal so Visualcare can read your worker and compliance data.

<Steps>
  <Step title="Open the Developer Portal">
    1. Log into Employment Hero
    2. Click your **profile icon** in the top-right corner
    3. Select **Developer Portal** from the dropdown menu

           <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/developer-portal-menu.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=119dd9ba6cff68ae890decfd908eef3d" alt="Click your profile icon, then select Developer Portal" width="1920" height="671" data-path="images/integrations/employment-hero/developer-portal-menu.png" />
  </Step>

  <Step title="Add a new application">
    1. On the **API** page, click **+ Add Application**

           <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/add-application.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=431a01153fcc1039914c7baa1d139078" alt="Click + Add Application to begin" width="760" height="451" data-path="images/integrations/employment-hero/add-application.png" />

    2. Fill in the application details:

    * **Application Name:** Visualcare (or any name of your choice)
    * **Redirect URI:** `https://app.visualcare.com.au/inc/export/employmenthero/index.php`

          <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/application-details.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=75d1c0b2b6f16311636e748dacb87fc0" alt="Enter the application name and redirect URI exactly as shown" width="1920" height="663" data-path="images/integrations/employment-hero/application-details.png" />
  </Step>

  <Step title="Select the required scopes">
    Scroll down to the scope selection area. You need to enable **Read** access for each of the following:

    * **Certifications** (Read)
    * **Employees** (Read)
    * **Employees certifications** (Read)
    * **Leave requests** (Read)
    * **Organisations** (Read, under the **User** section)

    <Warning>Only select Read access for each scope. Do not enable Update, Create, or Delete permissions. Visualcare only needs to read your data.</Warning>

    <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/scopes-certifications.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=37933b27cf38871a0155eb0b6765d5d3" alt="Tick Read under Certifications" width="1920" height="951" data-path="images/integrations/employment-hero/scopes-certifications.png" />

    <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/scopes-organisations.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=f7cb785031b9ffecb6c422f05e354486" alt="Tick Read under Organisations in the User section. You should see 12 scopes selected" width="1920" height="923" data-path="images/integrations/employment-hero/scopes-organisations.png" />
  </Step>

  <Step title="Review and create the application">
    1. Click **Continue to Review**
    2. Confirm the application name, redirect URI, and all 12 scopes look correct
    3. Click **Create Application**

    <Warning>There is no way to change the scopes after the application is created. If you need to adjust them later, delete the application and create a new one.</Warning>

    <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/review-application.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=f64bd776be2c4626a3ecc7db762c9f32" alt="Review the application details and scopes before creating" width="1920" height="1021" data-path="images/integrations/employment-hero/review-application.png" />

    4. You are shown a **Client ID** and **Client Secret**. Copy both immediately.

    <Warning>The Client ID and Client Secret are only displayed once. If you navigate away without copying them, you need to delete the application and start again.</Warning>

    <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/api-credentials.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=f1e71d3b47c4b6687d673847f4ecd02c" alt="Copy the Client ID and Client Secret straight away" width="1920" height="980" data-path="images/integrations/employment-hero/api-credentials.png" />
  </Step>
</Steps>

## Part 2: Authorise the connection

Send your credentials to the Visualcare team and complete the authorisation to generate your access tokens.

<Steps>
  <Step title="Send your credentials to the Visualcare team">
    Send the **Client ID** and **Client Secret** to your Visualcare Implementation Consultant. We recommend sending these securely, for example:

    * A password-protected document with the password sent separately
    * A one-time secret sharing service

    <Warning>Keep these credentials secure. They provide access to your Employment Hero data. Do not share them in plain text over email.</Warning>

    The Visualcare team enters these into your database. Once confirmed, you move on to the next step.
  </Step>

  <Step title="Generate the access tokens">
    Once the Visualcare team confirms your Client ID and Secret have been entered, complete the following while logged into Visualcare:

    1. Open a new browser tab and navigate to: `https://app.visualcare.com.au/inc/export/employmenthero/auth.php`

    2. If prompted with a **Single Sign On Authorisation** screen, click **Authorised** next to your organisation

           <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/sso-authorisation.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=52d5967aa238e0c6523aa218bb1fb5c9" alt="Click Authorised next to your organisation if prompted" width="1920" height="800" data-path="images/integrations/employment-hero/sso-authorisation.png" />

    3. On the **Authorize with EmploymentHero** screen, review the permissions and click **Allow**

           <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/authorize-allow.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=914ae44c6af501933c4b4745b796aae1" alt="Review the permissions, then click Allow" width="1920" height="922" data-path="images/integrations/employment-hero/authorize-allow.png" />

    4. The page displays three values: **Access Token**, **Refresh Token**, and **Code**

    5. Copy all three values and send them to the Visualcare team using the same secure method as the previous step

           <img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/tokens-page.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=9031ad3bf8eec57d352467637364ce4a" alt="Copy the Access Token, Refresh Token, and Code" width="960" height="289" data-path="images/integrations/employment-hero/tokens-page.png" />

    <Info>The Visualcare team enters these tokens to finalise the connection. Once complete, your Employment Hero data begins syncing to Visualcare daily at approximately 2am ACST.</Info>
  </Step>
</Steps>

## Part 3: Match compliance items in Visualcare

For certificates to sync correctly, each Employment Hero certificate needs to be linked to a corresponding worker compliance item in Visualcare. Visualcare matches Employment Hero's ID to the **External Id** field on the compliance item. This is a one-time setup you do yourself.

1. In Visualcare, go to **Maintenance** → **Workers** → **Worker Compliance**

<img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/worker-compliance-nav.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=3470851a7b72d4e0efe3a4c7619b1931" alt="Navigate to Maintenance, Workers, Worker Compliance" width="1920" height="891" data-path="images/integrations/employment-hero/worker-compliance-nav.png" />

2. Click **Sync EH Certificate**
3. Select a compliance item from the table at the bottom of the screen
4. Select the matching **External ID** from the dropdown at the top of the screen
5. Click **Save**
6. Repeat steps 3 to 5 for each certificate you want to sync

<img src="https://mintcdn.com/visualcare/q3JTOkpVwZ5rX_wn/images/integrations/employment-hero/sync-eh-certificate.png?fit=max&auto=format&n=q3JTOkpVwZ5rX_wn&q=85&s=5536f5abf9234577ece2a529b063cc79" alt="Select the compliance item, then choose the matching External ID from the dropdown" width="1920" height="799" data-path="images/integrations/employment-hero/sync-eh-certificate.png" />

<Tip>The compliance item in Visualcare needs to exist before you map it. If your compliance items are not set up yet, ask your Implementation Consultant to help you create them first.</Tip>

Only certificates with a status of **Active** or **Approved** in Employment Hero sync across to Visualcare. Compliance items are refreshed daily. Any compliance item created by `api@visualcare.com.au` is removed and replaced with the latest data from Employment Hero. Start dates and expiry dates are added to Visualcare if they are present in Employment Hero.

<Tip>A log file is sent with the daily results of the update so you can review what was synced.</Tip>

## Running into issues?

See [Integration troubleshooting](/troubleshooting/integration-issues) for common errors and fixes.

## Related articles

<CardGroup cols={2}>
  <Card title="Managing worker compliance" icon="clipboard-check" href="/worker-management/managing-worker-compliance">
    Set up and manage compliance items for workers
  </Card>

  <Card title="Xero integration" icon="building-columns" href="/integrations/xero">
    Connect Visualcare to Xero for invoice and payroll export
  </Card>

  <Card title="KeyPay integration" icon="credit-card" href="/integrations/keypay">
    Connect Visualcare to KeyPay for payroll export
  </Card>
</CardGroup>
