> ## 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 Webhook Setup Guide

> Configure Employment Hero to deliver events to StackOne.

## Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See [Getting Started](https://docs.stackone.com/connectors/employmenthero.md#getting-started) on the Employment Hero connector page.

## Retrieve the Native Webhook URL

The **Native Webhook URL** is generated once an account has been linked.

<ul>
  <li>Open the linked account in StackOne.</li>
  <li>Copy the value from **Native Webhook URL**.</li>
</ul>

## Add a webhook in Employment Hero

Register the Native Webhook URL as a webhook in the Employment Hero Developer Portal and select the events to send.

**1. Open the Developer Portal**

Sign in to your [Employment Hero account](https://secure.employmenthero.com/users/sign_in), click your profile name in the top right corner and select **Developer Portal**.

![The profile menu open with the Developer Portal item highlighted](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-developer-portal.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=c5a2cac53a2a62488eb62f8f76ef2f15)

**2. Open My Webhooks**

In the sidebar, expand **Webhooks** and click **My Webhooks**.

![The Developer Portal sidebar with Webhooks expanded and My Webhooks highlighted](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-my-webhooks-menu.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=b7413a4d76a321910fa9dc1164d2c140)

**3. Add a webhook**

Click **Add Webhook**.

![The My Webhooks page with the Add Webhook button highlighted](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-add-webhook.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=27b7d3597d85bc44c03d4d666b73876a)

**4. Enter the webhook details**

In the **Add new webhook** dialog, fill in the **Name** and **URL** fields.

<ul>
  <li>**Name**: any name you choose — for example, `StackOne Integration`</li>
  <li>**URL**: the Native Webhook URL copied from StackOne</li>
</ul>

![The Add new webhook dialog with the Name and URL fields highlighted](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-webhook-details.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=199abdb0e9ccc6f70232099ba95271f1)

**5. Select events and create the webhook**

Under **Events**, tick every event you enabled in StackOne, then click **Create**.

<ul>
  <li>Employment Hero only sends the events ticked here.</li>
  <li>Changes made later through **Edit** take effect immediately.</li>
</ul>

![The Add new webhook dialog with all events ticked and the Create button highlighted](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-select-events.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=354650463e5f8c5ef0abe58350bd43e8)

**6. Review the webhook**

The **View webhook** dialog opens with the saved settings. The **Client secret** is the key Employment Hero uses to sign each request in the `X-EmploymentHero-Signature` header. StackOne does not need it.

<ul>
  <li>Click **Close** to return to **My Webhooks**.</li>
</ul>

![The View webhook dialog with the Client secret field highlighted and its value hidden](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-view-webhook.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=2e7f09c7bfad10ea655237b171c19fea)

**7. Confirm the webhook is listed**

The webhook appears on **My Webhooks** with its name, creation time and selected events.

<ul>
  <li>Deliveries can be checked under **Webhooks** > **Event History**.</li>
</ul>

![The My Webhooks page with the StackOne Integration webhook card highlighted](https://mintcdn.com/stackone-60/yXlVTLcD6Q2JasB6/connectors/employmenthero/images/events-webhook-created.png?fit=max\&auto=format\&n=yXlVTLcD6Q2JasB6\&q=85\&s=55a43aa076677388334000834429f4e4)

## Available webhook events

The following Employment Hero events can be enabled. Only events selected in StackOne are processed, and Employment Hero only sends the events ticked on the webhook.

**1. Employee events**

Events related to employee records.

<ul>
  <li>**Employee Created** (`employee_created`) — Fired when a new employee is created</li>
  <li>**Employee Onboarded** (`employee_onboarded`) — Fired when an employee completes onboarding</li>
  <li>**Employee Updated** (`employee_updated`) — Fired when an employee's details are updated</li>
  <li>**Employee Offboarding** (`employee_offboarding`) — Fired when an employee is put into offboarding</li>
</ul>

**2. Bank account events**

Events related to employee bank accounts.

<ul>
  <li>**Bank Account Created** (`bank_account_created`) — Fired when a bank account is added to an employee</li>
  <li>**Bank Account Updated** (`bank_account_updated`) — Fired when an employee's bank account is updated</li>
  <li>**Bank Account Deleted** (`bank_account_deleted`) — Fired when an employee's bank account is deleted</li>
</ul>

**3. Employment history events**

Events related to employment history entries.

<ul>
  <li>**Employment History Created** (`employment_history_created`) — Fired when an employment history entry is created</li>
  <li>**Employment History Updated** (`employment_history_updated`) — Fired when an employment history entry is updated</li>
  <li>**Employment History Deleted** (`employment_history_deleted`) — Fired when an employment history entry is deleted</li>
</ul>

**4. Custom field events**

Events related to custom field definitions and the values held against employees.

<ul>
  <li>**Employee Custom Field Created** (`employee_custom_field_created`) — Fired when a custom field value is set on an employee</li>
  <li>**Employee Custom Field Updated** (`employee_custom_field_updated`) — Fired when an employee's custom field value changes</li>
  <li>**Employee Custom Field Deleted** (`employee_custom_field_deleted`) — Fired when an employee's custom field value is removed</li>
  <li>**Custom Field Created** (`custom_field_created`) — Fired when a custom field definition is created</li>
  <li>**Custom Field Updated** (`custom_field_updated`) — Fired when a custom field definition is updated</li>
  <li>**Custom Field Deleted** (`custom_field_deleted`) — Fired when a custom field definition is deleted</li>
</ul>

**5. Leave request events**

Events related to leave requests.

<ul>
  <li>**Leave Request Created** (`leave_request_created`) — Fired when a leave request is submitted</li>
  <li>**Leave Request Updated** (`leave_request_updated`) — Fired when a leave request is edited</li>
  <li>**Leave Request Approved** (`leave_request_approved`) — Fired when a leave request is approved</li>
  <li>**Leave Request Declined** (`leave_request_declined`) — Fired when a leave request is declined</li>
  <li>**Leave Request Deleted** (`leave_request_deleted`) — Fired when a leave request is deleted</li>
</ul>

**6. Timesheet entry events**

Events related to timesheet entries.

<ul>
  <li>**Timesheet Entry Created** (`timesheet_entry_created`) — Fired when a timesheet entry is created</li>
  <li>**Timesheet Entry Updated** (`timesheet_entry_updated`) — Fired when a timesheet entry is updated</li>
  <li>**Timesheet Entry Deleted** (`timesheet_entry_deleted`) — Fired when a timesheet entry is deleted</li>
</ul>

**7. Certification events**

Events related to certifications and the certifications assigned to employees.

<ul>
  <li>**Certification Created** (`certification_created`) — Fired when a certification is created in the organisation</li>
  <li>**Certification Updated** (`certification_updated`) — Fired when a certification is updated</li>
  <li>**Certification Deleted** (`certification_deleted`) — Fired when a certification is deleted</li>
  <li>**Certification Archived** (`certification_archived`) — Fired when a certification is archived</li>
  <li>**Member Certification Created** (`member_certification_created`) — Fired when a certification is assigned to an employee</li>
  <li>**Member Certification Updated** (`member_certification_updated`) — Fired when an employee's certification is updated</li>
  <li>**Member Certification Approved** (`member_certification_approved`) — Fired when an employee's certification is approved</li>
  <li>**Member Certification Declined** (`member_certification_declined`) — Fired when an employee's certification is declined</li>
  <li>**Member Certification Expired** (`member_certification_expired`) — Fired when an employee's certification expires</li>
  <li>**Member Certification Archived** (`member_certification_archived`) — Fired when an employee's certification is archived</li>
  <li>**Member Certification Deleted** (`member_certification_deleted`) — Fired when an employee's certification is deleted</li>
</ul>

**8. Custom form response events**

Events related to custom form responses.

<ul>
  <li>**Custom Form Response Submitted** (`custom_form_response_submitted`) — Fired when a custom form response is submitted</li>
  <li>**Custom Form Response Approved** (`custom_form_response_approved`) — Fired when a custom form response is fully approved</li>
  <li>**Custom Form Response Declined** (`custom_form_response_declined`) — Fired when a custom form response is declined</li>
  <li>**Custom Form Response Partially Approved** (`custom_form_response_step_approved`) — Fired when one approval step of a custom form response is approved; the payload carries approver\_id and decliner\_id but no form\_id</li>
</ul>

**9. Goal and key result events**

Events related to goals and their key results.

<ul>
  <li>**Goal Created** (`goal_created`) — Fired when a goal is created</li>
  <li>**Goal Updated** (`goal_updated`) — Fired when a goal is updated, including archive and unarchive</li>
  <li>**Goal Deleted** (`goal_deleted`) — Fired when a goal is deleted</li>
  <li>**Key Result Created** (`key_result_created`) — Fired when a key result is added to a goal</li>
  <li>**Key Result Updated** (`key_result_updated`) — Fired when a key result is updated, including archive and unarchive</li>
  <li>**Key Result Deleted** (`key_result_deleted`) — Fired when a key result is deleted</li>
</ul>

## Delivery format

Details of how Employment Hero delivers events to StackOne.

**1. One event per request**

Each request is a JSON object with `event` (the event code, for example `leave_request_approved`) and `data` (the affected record). StackOne routes each delivery on `event` and uses `data.id` as the record id.

**2. Retries**

If the URL does not respond with HTTP 200, Employment Hero retries up to 3 times and then marks the event as failed in **Event History**.

## Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.


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