Skip to main content
Connector guides

Connect Employment Hero

Employment Hero is a cloud HR and payroll platform used by organisations in Australia, New Zealand, the United Kingdom, Singapore, Malaysia and Canada. It holds the employee records, leave, documents,…

Written By Christopher Scaminaci

Last updated About 3 hours ago

Employment Hero is a cloud HR and payroll platform used by organisations in Australia, New Zealand, the United Kingdom, Singapore, Malaysia and Canada. It holds the employee records, leave, documents, onboarding and offboarding, timesheets and rosters, the asset register, forms, goals, benefits and pay data. StackJack talks to it through Employment Hero's own API.

Connecting Employment Hero to StackJack gives your AI assistant a family of eh_ MCP tools. MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

  • See who is out of office - one request lists leave across the whole organisation for any date range and any approval status, so "who is off next week?" is a single question
  • Look people up - employees and contractors, teams (called Groups in the Employment Hero product), employment and job history, emergency contacts, work eligibility and custom fields
  • Onboard and offboard - add an employee or contractor, run a full onboarding and follow its progress, and end someone's employment. This is the hand-off point to your other tools: a new hire in Employment Hero becomes an account to create, and a leaver becomes an account to disable
  • Manage leave - read balances, categories and requests, raise or change a request, and approve or decline one
  • Handle employee documents - list the documents held for an employee and upload a new one, plus the compliance document tags, certifications and policies around them
  • Run time and rosters - timesheet entries and their approval, rostered shifts and their cost, roster unavailability, Hero Time Clock access and sales or forecast data
  • Read and shape the organisation - work sites, work locations, departments, positions, cost centres and employing entities
  • Track the asset register - assets, their categories and custom fields, who holds each one, and the assign, return, reassign and dispose steps that follow a laptop or phone through its life
  • Work with forms and goals - form templates, forms, assignments and responses, and goals with their key results and check-ins
  • Read pay and benefits - pay details, payslips, pay categories, awards, classifications and the benefits assigned to each person
  • Read payroll identity details - bank account, superannuation and tax records, on request only. These are sensitive and are labeled that way
  • Read the Careers Page (optional) - the countries, departments and public jobs published on your own careers site

Reading is available on every plan. Anything that changes data, from raising a leave request to uploading a document, is on Pro plans, and anything that cannot easily be undone is labeled as a change that needs approval.

See the generated Employment Hero tool reference for the current inventory, plan assignment, input schemas, and destructive-action labels.

What you need before you start

  • An Employment Hero plan that includes API access. That is HR Elite or Employment Unlimited. An organisation on HR Essentials or HR Engage cannot connect. If you are not sure, ask your Employment Hero account manager first.
  • An owner or admin account. The connection carries the permissions of the person who signs in, so an owner or admin sees the most. A narrower account sees less, and most tools then answer with a permission error.

How StackJack connects to Employment Hero

You sign in. There is nothing to register, no keys to create and nothing to paste.

Open the Employment Hero connector in StackJack, click Connect Employment Hero, sign in to Employment Hero and approve StackJack. That is the whole setup. StackJack keeps the connection current afterwards, so you do not sign in again unless you disconnect it.

One connection per customer organisation

A connection reaches the organisations the signed-in person can see. If you look after several customers, add one connection for each and name it after the customer, for example "Acme Pty Ltd" and not "Employment Hero 2". Your AI then knows which organisation you mean when you ask "who is out of office at Acme?". An organisation that enforces single sign-on can only be authorised once per connection, so add a separate connection for each of those.

Steps

  1. Open Connectors in the StackJack portal and choose Employment Hero.
  2. Click Add connection if you already have one, and name it after the customer.
  3. Click Connect Employment Hero and sign in with an owner or admin account.
  4. Approve StackJack when Employment Hero asks.
  5. Optional: open the connection again and enter a Default organisation id. Every Employment Hero request names an organisation, and a saved default lets your AI leave it out. Ask your assistant to list your organisations if you do not know the id, then click Save.
  6. Optional: paste a Careers Page API access token if you want the three Careers Page tools. In Employment Hero open General Settings, then Recruitment Settings, and copy the token once the Careers Page is enabled. It is a separate credential from your sign-in and is not checked by Test Connection.
  7. Use Test Connection. It reads the first organisation your account can see, which confirms the sign-in without touching any employee data.

Good to know

  • Dates. Employment Hero uses YYYY-MM-DD almost everywhere. Two places differ: the termination date when you offboard someone, and the date filters on the timesheet list, both of which use DD/MM/YYYY. Your AI knows this, but it is the first thing to check if a date is refused.
  • Leave balances work only for organisations that use Employment Hero's own leave, not for payroll-connected organisations.
  • Documents can be listed and uploaded for one employee at a time. Employment Hero offers no way to update or delete a document, or to list documents across the whole organisation, so check the employee and the name before you upload.
  • Some requests finish later. Creating or changing a certification, onboarding an employee and creating many rostered shifts at once answer with a reference, and a second request reads the outcome. Your AI follows up on its own.
  • Some changes email people or change pay. Changing a salary, work hours or a leave balance alters pay or entitlements, and creating, publishing or assigning a form, granting or removing Hero Time Clock access and assigning many assets at once reach real people. These are labeled as changes that need approval, as are deletes, offboarding, and approving or declining a leave request or a form response. Assigning, reassigning or creating a single asset and updating a certification can email someone too, but only when your AI turns that email option on, and they are not labeled that way, so say in your request whether people should be told.
  • Offboarding and deleting are different. Offboarding ends employment and keeps the record. Deleting removes the employee file and cannot be undone.
  • Rate limits. Employment Hero allows 20 requests a second and 100 a minute. A very large list is better narrowed with a date range than read page by page.

Troubleshooting

  • Connect fails straight away. The Employment Hero connection is being prepared on StackJack's side and may not be available yet. Contact StackJack support if it persists.
  • "Employment Hero no longer accepts this connection's sign-in". The sign-in was revoked or has expired. Open the connector and click Connect Employment Hero again.
  • A tool answers with a permission error while others work. The account that connected does not have permission for that area. Connect with an owner or admin account, and check the plan includes API access.
  • A tool names no organisation. Either pass the organisation id, or save a default organisation on the connection.

Employment Hero tools

eh_ · 167 tools · Free 75 · Pro 92

Organisations

ToolWhat it does
eh_get_organisation
Free · Read-only
Retrieves information for a specific organisation.
eh_list_organisations
Free · Read-only
Returns an array of all organisations.

People

ToolWhat it does
eh_bulk_update_employee_custom_fields
Pro · Write
Updates multiple custom field values for a specific employee in a single request.
eh_delete_employee
Pro · Destructive
DESTRUCTIVE: permanently deletes a specific employee from the organisation.
eh_get_employee
Free · Read-only
Retrieves a specific employee.
eh_get_onboard_employee_status
Free · Read-only
Allows you to check the status of an employee onboarding process that was initiated using the `Polling Onboard Employee` endpoint.
eh_get_work_eligibility
Free · Read-only
Retrieves work eligibility information for a specific employee.
eh_list_custom_fields
Free · Read-only
Retrieves a list of all custom fields for a specific organisation.
eh_list_emergency_contacts
Free · Read-only
Retrieves a list of all emergency contacts for a specific employee.
eh_list_employee_custom_fields
Free · Read-only
Retrieves a list of all custom fields for a specific employee.
eh_list_employees
Free · Read-only
Returns an array of all employees.
eh_list_employment_histories
Free · Read-only
Retrieves a list of the complete employment history for a specific employee.
eh_list_job_histories
Free · Read-only
Retrieves job history information for a specific employee.
eh_list_team_employees
Free · Read-only
Returns an array of employees associated to a specific team.
eh_list_teams
Free · Read-only
Returns an array of all teams.
eh_offboard_employee
Pro · Destructive
DESTRUCTIVE: offboards (terminates) an employee.
eh_onboard_employee
Pro · Write
Initiates a comprehensive employee onboarding process using a polling-based approach.
eh_quick_add_contractor
Pro · Write
Creates a new contractor record with minimal required information for quick onboarding.
eh_quick_add_employee
Pro · Write
Creates a new employee record with minimal required information for quick onboarding.
eh_update_contractor_details
Pro · Write
Updates contractor-specific details for an employee who is flagged as an independent contractor (`independent_contractor = true`).
eh_update_employee_custom_field
Pro · Write
Updates the value of a single custom field for a specific employee.
eh_update_employment_details
Pro · Write
Updates the employment details for a specific employee.
eh_update_personal_details
Pro · Write
Updates the personal details for a specific employee.

Leave and availability

ToolWhat it does
eh_approve_leave_request
Pro · Destructive
DESTRUCTIVE: approve an employee's leave request.
eh_create_leave_request
Pro · Write
Creates a new leave request for a specific employee.
eh_decline_leave_request
Pro · Destructive
DESTRUCTIVE: decline an employee's leave request.
eh_delete_leave_request
Pro · Destructive
DESTRUCTIVE: permanently delete an existing leave request for an employee.
eh_get_leave_request
Free · Read-only
Retrieves a specific leave request.
eh_get_unavailability
Free · Read-only
Get unavailability record using its ID.
eh_list_employee_leave_requests
Free · Read-only
Retrieves a list of leave requests belonging to a specific employee, optionally filtered by status, leave category, and date range.
eh_list_leave_balances
Free · Read-only
Retrieves a paginated list of leave balances for a specific employee within an organisation.
eh_list_leave_categories
Free · Read-only
Retrieves a paginated list of leave categories available within the specified organisation.
eh_list_leave_requests
Free · Read-only
Retrieves a list of all leave requests, optionally filtered by status, leave category, and date range.
eh_list_unavailabilities
Free · Read-only
Get all unavailability records satisfying the provided conditions.
eh_update_leave_balance
Pro · Destructive
DESTRUCTIVE: updates the accrued amount of a specific leave balance for an employee.
eh_update_leave_request
Pro · Write
Partially update an existing leave request for an employee.
eh_upload_leave_request_files
Pro · Write
Upload supporting files (such as medical certificates) for a leave request.

Documents and compliance

ToolWhat it does
eh_archive_compliance_document_tag
Pro · Destructive
DESTRUCTIVE: archives a compliance document tag, excluding it from future document tagging operations.
eh_create_certification
Pro · Write
Creates a new certification within an organisation.
eh_create_compliance_document_tag
Pro · Write
Creates a new compliance document tag for the organisation.
eh_create_employee_document
Pro · Write
Uploads a document for a specific employee.
eh_delete_certification
Pro · Destructive
DESTRUCTIVE: deletes a specific certification within an organisation asynchronously.
eh_get_certification
Free · Read-only
Retrieves a specific certification.
eh_get_certification_polling_status
Free · Read-only
Retrieves the status of an async certification operation.
eh_list_certifications
Free · Read-only
Retrieves a paginated list of all certifications for a specific organisation.
eh_list_compliance_document_tags
Free · Read-only
Returns all compliance document tags belonging to the organisation.
eh_list_employee_certification_details
Free · Read-only
Retrieves a list of all certifications assigned to a specific employee.
eh_list_employee_documents
Free · Read-only
Returns an array of the employee's uploaded documents.
eh_list_policies
Free · Read-only
Retrieves a list of all policies for a specific organisation.
eh_update_certification
Pro · Write
Updates an existing certification within an organisation.
eh_update_certification_archive_status
Pro · Write
Archives or unarchives a certification based on the specified status.
eh_update_compliance_document_tag
Pro · Write
Renames an existing compliance document tag.
eh_update_employee_certification
Pro · Write
Updates the completion details for an employee's assigned certification record.
eh_upload_certification_files
Pro · Write
Upload certification attachment files.
eh_upload_employee_certification_files
Pro · Write
Upload one or more supporting documents for an employee's certification.

Time and rostering

ToolWhat it does
eh_approve_timesheet_entry
Pro · Write
Approve a single timesheet entry.
eh_bulk_approve_timesheet_entries
Pro · Destructive
DESTRUCTIVE: approve up to 10 timesheet entries in a single request.
eh_bulk_create_rostered_shifts
Pro · Write
Create a background job to handle rostered shifts bulk creation.
eh_bulk_decline_timesheet_entries
Pro · Destructive
DESTRUCTIVE: decline up to 10 timesheet entries in a single request with an optional shared reason.
eh_bulk_grant_access
Pro · Destructive
DESTRUCTIVE: grant Hero Time Clock (Kiosk) access to multiple members.
eh_bulk_revoke_access
Pro · Destructive
DESTRUCTIVE: revokes Hero Time Clock access for multiple members in the specified organisation.
eh_create_sales_data
Pro · Write
Create a batch of sales data records (actual sales and/or forecasts) for an organisation.
eh_create_timesheet_entries
Pro · Write
Allows you to create multiple timesheet entries for different employees in a single request.
eh_decline_timesheet_entry
Pro · Write
Decline a single timesheet entry with an optional reason.
eh_delete_timesheet_entry
Pro · Destructive
DESTRUCTIVE: permanently delete a single timesheet entry.
eh_get_rostered_shift
Free · Read-only
Get rostered shift record using its ID.
eh_get_rostered_shift_cost
Free · Read-only
Get the summarized rostered shift costs for a given period of time.
eh_get_rostered_shifts_bulk_create_status
Free · Read-only
Get a particular rostered shift bulk create job by its job id.
eh_list_kiosk_members
Free · Read-only
Retrieves a paginated list of members with their Hero Time Clock access status for the specified organisation.
eh_list_roles
Free · Read-only
Get roles (standalone HR) or tags (payroll-connected).
eh_list_rostered_shifts
Free · Read-only
List all the rostered shifts accessible by current user.
eh_list_sales_data
Free · Read-only
List sales data submitted for a work site within a date range.
eh_list_timesheet_entries
Free · Read-only
Retrieves a list of all timesheet entries for a specific employee.
eh_list_work_types
Free · Read-only
Retrieves a paginated list of work types available within the specified organisation.
eh_update_timesheet_entry
Pro · Write
Update any editable field on an existing timesheet entry.

Organisation structure

ToolWhat it does
eh_create_department
Pro · Write
Create a new department for a work site.
eh_create_position
Pro · Write
Create a new HR position for a work site.
eh_create_work_site
Pro · Write
Create a work site, and create a default availability status `in_office` alongside this worksite if an organisation has access to workforce visibility.
eh_list_cost_centres
Free · Read-only
Retrieves a paginated list of cost centres available within the specified organisation.
eh_list_employing_entities
Free · Read-only
Retrieves a paginated list of employing entities available within the specified organisation.
eh_list_work_locations
Free · Read-only
Retrieves a paginated list of work locations available within the specified organisation.
eh_list_work_sites
Free · Read-only
Retrieve a paginated list of work sites for an organisation.
eh_update_department
Pro · Write
Update an existing department.
eh_update_position
Pro · Write
Update an existing HR position.
eh_update_work_site
Pro · Destructive
DESTRUCTIVE: updates a specific work site.

Assets

ToolWhat it does
eh_assign_asset
Pro · Write
Assigns an available asset to an employee.
eh_bulk_assign_assets
Pro · Destructive
DESTRUCTIVE: assigns up to 30 assets to employees in a single atomic request.
eh_create_asset
Pro · Write
Creates a new asset record in the organisation.
eh_create_asset_category
Pro · Write
Creates a new asset category for the organisation.
eh_create_asset_custom_field
Pro · Write
Creates a new custom field definition for the organisation's assets.
eh_delete_asset
Pro · Destructive
DESTRUCTIVE: permanently delete an asset from the organisation's asset register.
eh_delete_asset_category
Pro · Destructive
DESTRUCTIVE: permanently removes an asset category from the organisation.
eh_delete_asset_custom_field
Pro · Destructive
DESTRUCTIVE: permanently deletes a custom field definition and all values stored for that field across every asset in the organisation.
eh_dispose_asset
Pro · Destructive
DESTRUCTIVE: marks an asset as disposed with a reason and date, recording the disposal in the asset's history.
eh_get_asset
Free · Read-only
Retrieves the full details of a specific asset by its unique identifier.
eh_list_asset_assignment_history
Free · Read-only
Retrieves the complete, paginated assignment history of an asset, ordered newest first.
eh_list_asset_categories
Free · Read-only
Returns a paginated list of asset categories for the organisation.
eh_list_asset_custom_fields
Free · Read-only
Retrieves all custom field definitions for a specific organisation's asset register, so you know what fields are available before creating or updating assets.
eh_list_assets
Free · Read-only
Retrieve a paginated list of assets belonging to an organisation.
eh_reassign_asset
Pro · Write
Transfers an asset from its current assignee to a different employee in a single atomic operation.
eh_return_asset
Pro · Write
Returns an asset from its currently assigned employee back to inventory.
eh_update_asset
Pro · Write
Partially updates an existing asset.
eh_update_asset_category
Pro · Write
Updates an existing asset category.
eh_update_asset_custom_field
Pro · Write
Renames an existing asset custom field definition.
eh_upload_asset_files
Pro · Write
Uploads one to three supporting files (invoices, photos, warranties) for an asset and returns a file ID for each.

Forms

ToolWhat it does
eh_approve_form_response
Pro · Destructive
DESTRUCTIVE: approves a pending form response.
eh_archive_form
Pro · Destructive
DESTRUCTIVE: archives an active or completed form, moving it out of the active lifecycle while preserving all existing responses.
eh_assign_form
Pro · Destructive
DESTRUCTIVE: assigns an active form to the specified employees, contractors, teams, and/or work locations as a to-do task, creating a completion request for each assignee.
eh_close_form
Pro · Destructive
DESTRUCTIVE: closes an active form, stopping it from accepting new submissions.
eh_create_form
Pro · Destructive
DESTRUCTIVE: creates a new custom form with its sections and questions.
eh_create_form_category
Pro · Write
Creates a new custom form category for the organisation.
eh_create_form_template
Pro · Write
Create a new form template with sections and questions.
eh_decline_form_response
Pro · Destructive
DESTRUCTIVE: declines a pending form response with a reason.
eh_delete_form
Pro · Destructive
DESTRUCTIVE: permanently deletes a form along with all of its associated data.
eh_delete_form_category
Pro · Destructive
DESTRUCTIVE: permanently deletes a custom form category.
eh_delete_form_template
Pro · Destructive
DESTRUCTIVE: permanently deletes a form template.
eh_get_form
Free · Read-only
Retrieves a single form, including its sections and questions.
eh_get_form_response
Free · Read-only
Retrieves a single form response, including all submitted answers.
eh_get_form_template
Free · Read-only
Retrieves a single form template including its full structure of sections and questions.
eh_list_form_assignments
Free · Read-only
Retrieves a paginated list of members assigned to a specific form along with their completion status.
eh_list_form_categories
Free · Read-only
Retrieves all form categories for the organisation.
eh_list_form_responses
Free · Read-only
Retrieves a paginated list of received responses for a form.
eh_list_form_templates
Free · Read-only
Retrieves a paginated list of form templates for the organisation.
eh_list_forms
Free · Read-only
Retrieves a paginated list of forms for the organisation.
eh_list_member_form_responses
Free · Read-only
Retrieves a paginated list of form responses for a specific member.
eh_publish_form
Pro · Destructive
DESTRUCTIVE: publishes a draft form, transitioning it from `draft` to `active`.
eh_update_form
Pro · Write
Updates an existing form.
eh_update_form_category
Pro · Write
Renames a custom form category for the organisation.
eh_update_form_template
Pro · Write
Updates an existing form template.

Goals

ToolWhat it does
eh_create_goal
Pro · Write
Creates a new goal within an organisation.
eh_create_goal_key_result
Pro · Write
Creates a new key result under a goal.
eh_delete_goal
Pro · Destructive
DESTRUCTIVE: permanently deletes a goal.
eh_delete_goal_key_result
Pro · Destructive
DESTRUCTIVE: permanently deletes a key result.
eh_get_goal
Free · Read-only
Retrieves a specific goal.
eh_get_goal_key_result
Free · Read-only
Retrieves the full details of a single key result for a goal.
eh_list_goal_comments
Free · Read-only
Retrieves a paginated list of comments for a goal.
eh_list_goal_key_results
Free · Read-only
Retrieves a paginated list of key results for a goal.
eh_list_goals
Free · Read-only
Retrieves a paginated list of goals for the organisation.
eh_update_goal
Pro · Write
Updates the details of an existing goal.
eh_update_goal_archive_status
Pro · Write
Archives or unarchives a goal.
eh_update_goal_health_status
Pro · Write
Records a health-status check-in on a goal.
eh_update_goal_key_result
Pro · Write
Updates an existing key result.
eh_update_goal_key_result_archive_status
Pro · Write
Archives or unarchives a key result.
eh_update_goal_key_result_health_status
Pro · Write
Records a check-in on a key result, updating its current value and health status.
eh_upload_goal_files
Pro · Write
Upload files for use as goal attachments.

Pay and benefits

ToolWhat it does
eh_assign_employee_benefit
Pro · Write
Assigns a benefit to a specific employee.
eh_create_salary_version
Pro · Destructive
DESTRUCTIVE: creates a new salary version for an employee.
eh_delete_employee_benefit
Pro · Destructive
DESTRUCTIVE: removes an employee benefit assignment.
eh_generate_payslip_pdf
Pro · Write
Enqueues a job to generate PDF for a particular payslip if not yet exists.
eh_get_payslip
Free · Read-only
Retrieves a particular payslip for a specific employee.
eh_list_awards_and_classifications
Free · Read-only
Returns a paginated list of awards and their associated classifications available for the organisation.
eh_list_benefits
Free · Read-only
Retrieves all benefit definitions configured for an organisation.
eh_list_employee_benefits
Free · Read-only
Retrieves all benefit assignments for a specific employee.
eh_list_organisation_employee_benefits
Free · Read-only
Retrieves paginated benefit assignments across all employees in an organisation.
eh_list_pay_categories
Free · Read-only
Retrieves a paginated list of pay categories available within the specified organisation.
eh_list_pay_details
Free · Read-only
Retrieves a list of all pay details for a specific employee.
eh_list_payslips
Free · Read-only
Retrieves a list of all payslips for a specific employee.
eh_update_employee_benefit
Pro · Write
Updates an existing employee benefit assignment.
eh_update_work_hours
Pro · Destructive
DESTRUCTIVE: updates the work hours for a specific employee.

Payroll identity

ToolWhat it does
eh_get_superannuation_detail_v1
Free · Read-only
A hash with a data property that contains a superannuation detail object.
eh_get_superannuation_detail_v2
Free · Read-only
Retrieves an employee's superannuation detail.
eh_get_tax_declaration_v2
Free · Read-only
Retrieves an employee's tax declaration.
eh_list_bank_accounts_v1
Free · Read-only
Retrieves a list of all bank accounts for a specific employee.
eh_list_bank_accounts_v2
Free · Read-only
Retrieves an employee's bank accounts.

Careers Page

ToolWhat it does
eh_list_ats_countries
Free · Read-only
Returns a collection of the countries listed in the role for an organisation.
eh_list_ats_departments
Free · Read-only
Returns a collection of the public departments for an organisation.
eh_list_ats_jobs
Free · Read-only
Returns a collection of the public jobs for an organisation.