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

# Employment Hero

> How to set up the Employment Hero connector, plus the actions and events that are available.

![Employment Hero](https://stackone-logos.com/api/employment-hero/filled/svg)

v2.2.0[See changelog](https://docs.stackone.com/connectors/employmenthero/changelog.md)

[52 actions](#actions) · [46 events](#events) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/employmenthero/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth application in the Employment Hero Developer Portal. Access is limited to the scopes enabl...

Optionally, configure receiving Events for Employment Hero into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/employmenthero/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/employmenthero/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

urn:admin:organisations:certifications:archive\_status:update

urn:admin:organisations:certifications:delete:delete

urn:admin:organisations:certifications:file\_uploads:create

urn:admin:organisations:certifications:list:read

urn:admin:organisations:certifications:new:create

urn:admin:organisations:certifications:show:read

urn:admin:organisations:certifications:update:update

urn:admin:organisations:certifications:update\_polling\_status:read

urn:admin:organisations:cost\_centres:list:read

urn:admin:organisations:custom\_fields:list:read

urn:admin:organisations:departments:new:create

urn:admin:organisations:departments:update:update

urn:admin:organisations:documents:list:read

urn:admin:organisations:documents:new:create

urn:admin:organisations:employees:bank\_accounts:list:read

urn:admin:organisations:employees:emergency\_contacts:list:read

urn:admin:organisations:employees:employee\_custom\_fields:list:read

urn:admin:organisations:employees:employment\_histories:list:read

urn:admin:organisations:employees:job\_histories:list:read

urn:admin:organisations:employees:list:read

urn:admin:organisations:employees:onboard\_employee:create

urn:admin:organisations:employees:onboard\_polling\_status:read

urn:admin:organisations:employees:pay\_details:list:read

urn:admin:organisations:employees:pay\_details:salary\_versions:create

urn:admin:organisations:employees:payslips:list:read

urn:admin:organisations:employees:quick\_add\_contractor:create

urn:admin:organisations:employees:quick\_add\_employee:create

urn:admin:organisations:employees:show:read

urn:admin:organisations:employees:superannuation\_detail:show:read

urn:admin:organisations:employees:tax\_declaration:show:read

urn:admin:organisations:employees:timesheet\_entries:list:read

urn:admin:organisations:employees\_certifications:list:read

urn:admin:organisations:employing\_entities:list:read

urn:admin:organisations:forms:list:read

urn:admin:organisations:forms:show:read

urn:admin:organisations:forms\_responses:list:read

urn:admin:organisations:forms\_responses:show:read

urn:admin:organisations:leave\_categories:list:read

urn:admin:organisations:leave\_requests:list:read

urn:admin:organisations:leave\_requests:show:read

urn:admin:organisations:policies:list:read

urn:admin:organisations:rostered\_shifts:list:read

urn:admin:organisations:rostered\_shifts:show:read

urn:admin:organisations:teams:employees:list:read

urn:admin:organisations:teams:list:read

urn:admin:organisations:unavailabilities:list:read

urn:admin:organisations:unavailabilities:show:read

urn:admin:organisations:work\_locations:list:read

urn:admin:organisations:work\_sites:list:read

urn:admin:organisations:work\_sites:new:create

urn:user:organisations:list:read

urn:user:organisations:show:read

No scopes found

52 actions

ActionDescriptionRequired scopes

List Organisations`employmenthero_list_organisations`

List all organisations accessible to the authenticated user

`urn:user:organisations:list:read`

List Employing Entities`employmenthero_list_employing_entities`

List all employing entities for an organisation

`urn:admin:organisations:employing_entities:list:read`

List Work Locations`employmenthero_list_work_locations`

List all work locations for an organisation

`urn:admin:organisations:work_locations:list:read`

List Work Sites`employmenthero_list_work_sites`

List all work sites for an organisation

`urn:admin:organisations:work_sites:list:read`

Create Work Site`employmenthero_create_work_site`

Create a new work site in the organisation

`urn:admin:organisations:work_sites:new:create`

Get Organisation`employmenthero_get_organisation`

Get details of a specific organisation

`urn:user:organisations:show:read`

List Employees`employmenthero_list_employees`

List all employees for an organisation

`urn:admin:organisations:employees:list:read`

Get Employee`employmenthero_get_employee`

Get a specific employee by ID

`urn:admin:organisations:employees:show:read`

Quick Add Employee`employmenthero_quick_add_employee`

Quickly add a new employee to the organisation

`urn:admin:organisations:employees:quick_add_employee:create`

Quick Add Contractor`employmenthero_quick_add_contractor`

Quickly add a new contractor to the organisation

`urn:admin:organisations:employees:quick_add_contractor:create`

List Employee Emergency Contacts`employmenthero_list_employee_emergency_contacts`

List emergency contacts for an employee

`urn:admin:organisations:employees:emergency_contacts:list:read`

List Employee Employment Histories`employmenthero_list_employee_employment_histories`

List employment history records for an employee

`urn:admin:organisations:employees:employment_histories:list:read`

List Employee Custom Fields`employmenthero_list_employee_custom_fields`

List custom field values for an employee

`urn:admin:organisations:employees:employee_custom_fields:list:read`

List Contractor Job Histories`employmenthero_list_contractor_job_histories`

List job history records for a contractor

`urn:admin:organisations:employees:job_histories:list:read`

Onboard Employee`employmenthero_polling_onboard_employee`

Comprehensive employee onboarding with full details

`urn:admin:organisations:employees:onboard_employee:create`

Get Onboarding Polling Status`employmenthero_polling_onboard_result`

Check the status of an async employee onboarding operation

`urn:admin:organisations:employees:onboard_polling_status:read`

List Teams`employmenthero_list_teams`

List all teams for an organisation

`urn:admin:organisations:teams:list:read`

List Team Employees`employmenthero_list_team_employees`

List all employees in a specific team

`urn:admin:organisations:teams:employees:list:read`

Create Department`employmenthero_create_department`

Create a new department in the organisation

`urn:admin:organisations:departments:new:create`

Update Department`employmenthero_update_department`

Update an existing department

`urn:admin:organisations:departments:update:update`

Get Leave Requests`employmenthero_get_leave_requests`

Get all leave requests for an organisation

`urn:admin:organisations:leave_requests:list:read`

Get Leave Request`employmenthero_get_leave_request`

Get a specific leave request by ID

`urn:admin:organisations:leave_requests:show:read`

List Leave Categories`employmenthero_list_leave_categories`

List leave categories for an organisation

`urn:admin:organisations:leave_categories:list:read`

List Timesheet Entries`employmenthero_list_timesheet_entries`

List timesheet entries for an employee

`urn:admin:organisations:employees:timesheet_entries:list:read`

List Rostered Shifts`employmenthero_list_rostered_shifts`

List rostered shifts for an organisation

`urn:admin:organisations:rostered_shifts:list:read`

Get Rostered Shift`employmenthero_get_rostered_shift`

Get a specific rostered shift by ID

`urn:admin:organisations:rostered_shifts:show:read`

List Unavailabilities`employmenthero_list_unavailabilities`

List unavailability records for an organisation

`urn:admin:organisations:unavailabilities:list:read`

Get Unavailability`employmenthero_get_unavailability`

Get a specific unavailability record by ID

`urn:admin:organisations:unavailabilities:show:read`

List Certifications`employmenthero_list_certifications`

List all certifications for an organisation

`urn:admin:organisations:certifications:list:read`

Get Certification`employmenthero_get_certification`

Get a specific certification by ID

`urn:admin:organisations:certifications:show:read`

Create Certification`employmenthero_create_certification`

Create a new certification in the organisation

`urn:admin:organisations:certifications:new:create`

Update Certification`employmenthero_update_certification`

Update an existing certification

`urn:admin:organisations:certifications:update:update`

Delete Certification`employmenthero_delete_certification`

Delete a certification from the organisation

`urn:admin:organisations:certifications:delete:delete`

Archive Certification`employmenthero_archive_certification`

Archive or unarchive a certification

`urn:admin:organisations:certifications:archive_status:update`

List Employee Certifications`employmenthero_list_employee_certifications`

List all certifications assigned to an employee

`urn:admin:organisations:employees_certifications:list:read`

Get Certification Polling Status`employmenthero_certification_polling_status`

Check the status of an async certification operation

`urn:admin:organisations:certifications:update_polling_status:read`

Upload Certification Files`employmenthero_upload_certification_files`

Upload attachment files for certifications

`urn:admin:organisations:certifications:file_uploads:create`

List Employee Documents`employmenthero_list_employee_documents`

List all documents for an employee

`urn:admin:organisations:documents:list:read`

Upload Employee Document`employmenthero_create_employee_document`

Upload a document for an employee

`urn:admin:organisations:documents:new:create`

List Forms`employmenthero_list_forms`

List all forms for an organisation

`urn:admin:organisations:forms:list:read`

Get Form`employmenthero_get_form`

Get a specific form by ID

`urn:admin:organisations:forms:show:read`

List Form Responses`employmenthero_list_form_responses`

List all responses for a specific form

`urn:admin:organisations:forms_responses:list:read`

Get Form Response`employmenthero_get_form_response`

Get a specific form response by ID

`urn:admin:organisations:forms_responses:show:read`

List Employee Bank Accounts`employmenthero_list_employee_bank_accounts`

List bank accounts for an employee

`urn:admin:organisations:employees:bank_accounts:list:read`

List Employee Pay Details`employmenthero_list_employee_pay_details`

List pay details for an employee

`urn:admin:organisations:employees:pay_details:list:read`

Create Employee Salary Version`employmenthero_create_employee_salary_version`

Change an employee's salary

`urn:admin:organisations:employees:pay_details:salary_versions:create`

List Employee Payslips`employmenthero_list_employee_payslips`

List payslips for an employee

`urn:admin:organisations:employees:payslips:list:read`

Get Employee Superannuation`employmenthero_get_employee_superannuation`

Get superannuation details for an employee

`urn:admin:organisations:employees:superannuation_detail:show:read`

Get Employee Tax Declaration`employmenthero_get_employee_tax_declaration`

Get tax declaration details for an employee

`urn:admin:organisations:employees:tax_declaration:show:read`

List Custom Fields`employmenthero_list_custom_fields`

List all custom fields for an organisation

`urn:admin:organisations:custom_fields:list:read`

List Policies`employmenthero_list_policies`

List all policies for an organisation

`urn:admin:organisations:policies:list:read`

List Cost Centres`employmenthero_list_cost_centres`

List all cost centres for an organisation

`urn:admin:organisations:cost_centres:list:read`

## Events

Tags

Select all
|
Clear

Bank Accounts

Certifications

Custom Fields

Employees

Employment Histories

Forms

Goals

Leave Requests

Timesheet Entries

Verification

Webhooks

No tags found

46 events

EventDescriptionTags

Webhook Verification`employmenthero_webhook_verification`

Acknowledges any delivery without an event field, such as a reachability check, without emitting an event.

Verification

Employee Created`employmenthero_webhook_employee_created`

Processes Employment Hero employee\_created events, fired when a new employee is created.

EmployeesWebhooks

Employee Onboarded`employmenthero_webhook_employee_onboarded`

Processes Employment Hero employee\_onboarded events, fired when an employee completes onboarding.

EmployeesWebhooks

Employee Updated`employmenthero_webhook_employee_updated`

Processes Employment Hero employee\_updated events, fired when an employee's details are updated.

EmployeesWebhooks

Employee Offboarding`employmenthero_webhook_employee_offboarding`

Processes Employment Hero employee\_offboarding events, fired when an employee is put into offboarding.

EmployeesWebhooks

Bank Account Created`employmenthero_webhook_bank_account_created`

Processes Employment Hero bank\_account\_created events, fired when a bank account is added to an employee.

Bank AccountsWebhooks

Bank Account Updated`employmenthero_webhook_bank_account_updated`

Processes Employment Hero bank\_account\_updated events, fired when an employee's bank account is updated.

Bank AccountsWebhooks

Bank Account Deleted`employmenthero_webhook_bank_account_deleted`

Processes Employment Hero bank\_account\_deleted events, fired when an employee's bank account is deleted.

Bank AccountsWebhooks

Employment History Created`employmenthero_webhook_employment_history_created`

Processes Employment Hero employment\_history\_created events, fired when an employment history entry is created.

Employment HistoriesWebhooks

Employment History Updated`employmenthero_webhook_employment_history_updated`

Processes Employment Hero employment\_history\_updated events, fired when an employment history entry is updated.

Employment HistoriesWebhooks

Employment History Deleted`employmenthero_webhook_employment_history_deleted`

Processes Employment Hero employment\_history\_deleted events, fired when an employment history entry is deleted.

Employment HistoriesWebhooks

Employee Custom Field Created`employmenthero_webhook_employee_custom_field_created`

Processes Employment Hero employee\_custom\_field\_created events, fired when a custom field value is set on an employee.

Custom FieldsWebhooks

Employee Custom Field Updated`employmenthero_webhook_employee_custom_field_updated`

Processes Employment Hero employee\_custom\_field\_updated events, fired when an employee's custom field value changes.

Custom FieldsWebhooks

Employee Custom Field Deleted`employmenthero_webhook_employee_custom_field_deleted`

Processes Employment Hero employee\_custom\_field\_deleted events, fired when an employee's custom field value is removed.

Custom FieldsWebhooks

Custom Field Created`employmenthero_webhook_custom_field_created`

Processes Employment Hero custom\_field\_created events, fired when a custom field definition is created.

Custom FieldsWebhooks

Custom Field Updated`employmenthero_webhook_custom_field_updated`

Processes Employment Hero custom\_field\_updated events, fired when a custom field definition is updated.

Custom FieldsWebhooks

Custom Field Deleted`employmenthero_webhook_custom_field_deleted`

Processes Employment Hero custom\_field\_deleted events, fired when a custom field definition is deleted.

Custom FieldsWebhooks

Leave Request Created`employmenthero_webhook_leave_request_created`

Processes Employment Hero leave\_request\_created events, fired when a leave request is submitted.

Leave RequestsWebhooks

Leave Request Updated`employmenthero_webhook_leave_request_updated`

Processes Employment Hero leave\_request\_updated events, fired when a leave request is edited.

Leave RequestsWebhooks

Leave Request Approved`employmenthero_webhook_leave_request_approved`

Processes Employment Hero leave\_request\_approved events, fired when a leave request is approved.

Leave RequestsWebhooks

Leave Request Declined`employmenthero_webhook_leave_request_declined`

Processes Employment Hero leave\_request\_declined events, fired when a leave request is declined.

Leave RequestsWebhooks

Leave Request Deleted`employmenthero_webhook_leave_request_deleted`

Processes Employment Hero leave\_request\_deleted events, fired when a leave request is deleted.

Leave RequestsWebhooks

Timesheet Entry Created`employmenthero_webhook_timesheet_entry_created`

Processes Employment Hero timesheet\_entry\_created events, fired when a timesheet entry is created.

Timesheet EntriesWebhooks

Timesheet Entry Updated`employmenthero_webhook_timesheet_entry_updated`

Processes Employment Hero timesheet\_entry\_updated events, fired when a timesheet entry is updated.

Timesheet EntriesWebhooks

Timesheet Entry Deleted`employmenthero_webhook_timesheet_entry_deleted`

Processes Employment Hero timesheet\_entry\_deleted events, fired when a timesheet entry is deleted.

Timesheet EntriesWebhooks

Certification Created`employmenthero_webhook_certification_created`

Processes Employment Hero certification\_created events, fired when a certification is created in the organisation.

CertificationsWebhooks

Certification Updated`employmenthero_webhook_certification_updated`

Processes Employment Hero certification\_updated events, fired when a certification is updated.

CertificationsWebhooks

Certification Deleted`employmenthero_webhook_certification_deleted`

Processes Employment Hero certification\_deleted events, fired when a certification is deleted.

CertificationsWebhooks

Certification Archived`employmenthero_webhook_certification_archived`

Processes Employment Hero certification\_archived events, fired when a certification is archived.

CertificationsWebhooks

Member Certification Created`employmenthero_webhook_member_certification_created`

Processes Employment Hero member\_certification\_created events, fired when a certification is assigned to an employee.

CertificationsWebhooks

Member Certification Updated`employmenthero_webhook_member_certification_updated`

Processes Employment Hero member\_certification\_updated events, fired when an employee's certification is updated.

CertificationsWebhooks

Member Certification Approved`employmenthero_webhook_member_certification_approved`

Processes Employment Hero member\_certification\_approved events, fired when an employee's certification is approved.

CertificationsWebhooks

Member Certification Declined`employmenthero_webhook_member_certification_declined`

Processes Employment Hero member\_certification\_declined events, fired when an employee's certification is declined.

CertificationsWebhooks

Member Certification Expired`employmenthero_webhook_member_certification_expired`

Processes Employment Hero member\_certification\_expired events, fired when an employee's certification expires.

CertificationsWebhooks

Member Certification Archived`employmenthero_webhook_member_certification_archived`

Processes Employment Hero member\_certification\_archived events, fired when an employee's certification is archived.

CertificationsWebhooks

Member Certification Deleted`employmenthero_webhook_member_certification_deleted`

Processes Employment Hero member\_certification\_deleted events, fired when an employee's certification is deleted.

CertificationsWebhooks

Custom Form Response Submitted`employmenthero_webhook_custom_form_response_submitted`

Processes Employment Hero custom\_form\_response\_submitted events, fired when a custom form response is submitted.

FormsWebhooks

Custom Form Response Approved`employmenthero_webhook_custom_form_response_approved`

Processes Employment Hero custom\_form\_response\_approved events, fired when a custom form response is fully approved.

FormsWebhooks

Custom Form Response Declined`employmenthero_webhook_custom_form_response_declined`

Processes Employment Hero custom\_form\_response\_declined events, fired when a custom form response is declined.

FormsWebhooks

Custom Form Response Partially Approved`employmenthero_webhook_custom_form_response_step_approved`

Processes Employment Hero custom\_form\_response\_step\_approved events, fired when one approval step of a custom form respo...

FormsWebhooks

Goal Created`employmenthero_webhook_goal_created`

Processes Employment Hero goal\_created events, fired when a goal is created.

GoalsWebhooks

Goal Updated`employmenthero_webhook_goal_updated`

Processes Employment Hero goal\_updated events, fired when a goal is updated, including archive and unarchive.

GoalsWebhooks

Goal Deleted`employmenthero_webhook_goal_deleted`

Processes Employment Hero goal\_deleted events, fired when a goal is deleted.

GoalsWebhooks

Key Result Created`employmenthero_webhook_key_result_created`

Processes Employment Hero key\_result\_created events, fired when a key result is added to a goal.

GoalsWebhooks

Key Result Updated`employmenthero_webhook_key_result_updated`

Processes Employment Hero key\_result\_updated events, fired when a key result is updated, including archive and unarchive...

GoalsWebhooks

Key Result Deleted`employmenthero_webhook_key_result_deleted`

Processes Employment Hero key\_result\_deleted events, fired when a key result is deleted.

GoalsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.