---
updatedAt: 2026-09-21T10:36:55.000Z
agentTools:
  projectIndex: https://apidocs.worklio.com/llms.txt
---

# WebHook Event Types

<br />

Full catalogue of the events you can subscribe to with a [webhook](/webhooks). Every event belongs to a **subscription type** (the entity the event happened to, e.g. `Employee`, `Payroll`, `Company`) and fires only when your webhook's `allowedEntries` includes that event's category — see [Registering a webhook](/webhooks#registering-a-webhook) for the `allowedEntries` values.

## Delivered fields

Every WEP webhook request contains four items:

| Field       | Description                                                                                                                            |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `companyId` | ID of the company where the webhook was triggered.                                                                                     |
| `action`    | The action name — identifies which event fired.                                                                                        |
| `refId`     | ID of the entity the event is about. For example, on payroll actions this is the payroll run ID, which you can use to look up the run. |
| `payload`   | Optional. In most cases, empty.                                                                                                        |

See [Event payload structure](/webhooks#event-payload-structure) for a worked example.

## `allowedEntries: 0` (All) only

| Subscription Type | Event | Description              |
| ----------------- | ----- | ------------------------ |
| WebHook           | Test  | WebHook has been tested. |

## `allowedEntries: 0` (All) or `1` (Payroll)

| Subscription Type | Event       | Description                                        |
| ----------------- | ----------- | -------------------------------------------------- |
| Payroll           | Started     | Payroll has started.                               |
| Payroll           | OnTimeSheet | Payroll run is now on TimeSheet.                   |
| Payroll           | Calculated  | Payroll has been calculated.                       |
| Payroll           | Approved    | Payroll has been approved.                         |
| Payroll           | Locked      | Payroll has been locked.                           |
| Payroll           | Finalized   | Payroll has been finalized and can't be discarded. |

## `allowedEntries: 0` (All) or `2` (Employee)

| Subscription Type           | Event                                             | Description                                         |
| --------------------------- | ------------------------------------------------- | --------------------------------------------------- |
| Employee                    | CreatedSystem *(back-office action supported)*    | Employee has been created in the system.            |
| Employee                    | UpdatedSystem *(back-office action supported)*    | Employee has been updated in the system.            |
| Employee                    | TerminatedSystem *(back-office action supported)* | Employee has been terminated in the system.         |
| Employee                    | Created                                           | Employee has been created.                          |
| Employee                    | Updated                                           | Employee has been updated.                          |
| Employee                    | Terminated                                        | Employee has been terminated.                       |
| PayAllocation               | Created                                           | Net Pay Allocation has been created.                |
| PayAllocation               | Updated                                           | Net Pay Allocation has been updated.                |
| PayAllocation               | Deleted                                           | Net Pay Allocation has been deleted.                |
| PayAllocation               | PriorityUpdated                                   | Net Pay Allocation priority/order has been changed. |
| ChildGarnishment            | Created                                           | ChildGarnishment has been created.                  |
| ChildGarnishment            | Updated                                           | ChildGarnishment has been updated.                  |
| MiscDeduction               | Created                                           | MiscDeduction has been created.                     |
| MiscDeduction               | Updated                                           | MiscDeduction has been updated.                     |
| Benefit                     | Created                                           | Benefit has been created.                           |
| Benefit                     | Updated                                           | Benefit has been updated.                           |
| Document                    | Created                                           | Document has been created.                          |
| Document                    | Signed                                            | Document has been signed.                           |
| EmployeeTOR                 | Created                                           | EmployeeTOR has been created.                       |
| EmployeeTOR                 | Updated                                           | EmployeeTOR has been updated.                       |
| DashboardEmployeeOrderItems | Updated                                           | Employee Dashboard order items have been updated.   |
| Onboarding                  | EeOnboardingEeFinishedPhase2                      | Employee finished their part of onboarding.         |
| HRTEvent\_                  | Create                                            | HR Tracking Event created.                          |
| HRTEvent\_                  | Update                                            | HR Tracking Event updated.                          |
| HRTEvent\_                  | Delete                                            | HR Tracking Event deleted.                          |
| W4                          | Requested                                         | W4 change has been requested.                       |
| W4                          | EeFinished                                        | W4 change has been finished by the employee.        |

## `allowedEntries: 0` (All) or `8` (Client)

| Subscription Type       | Event    | Description                                      |
| ----------------------- | -------- | ------------------------------------------------ |
| Company                 | Created  | Company has been created.                        |
| Company                 | Updated  | Company has been updated.                        |
| BankAccount             | Created  | BankAccount has been created.                    |
| BankAccount             | Updated  | BankAccount has been updated.                    |
| WorkLocation            | Created  | WorkLocation has been created.                   |
| WorkLocation            | Updated  | WorkLocation has been updated.                   |
| Department              | Created  | Department has been created.                     |
| Department              | Updated  | Department has been updated.                     |
| JobCostingSegment       | Updated  | JobCostingSegment has been updated.              |
| JobCostingSegmentValue  | Created  | JobCostingSegmentValue has been created.         |
| JobCostingSegmentValue  | Updated  | JobCostingSegmentValue has been updated.         |
| JobCostingSegmentValue  | Removed  | JobCostingSegmentValue has been removed.         |
| BenefitTemplate         | Created  | BenefitTemplate has been created.                |
| BenefitTemplate         | Updated  | BenefitTemplate has been updated.                |
| TimeOffRequest          | Created  | TimeOffRequest has been created.                 |
| TimeOffRequest          | Updated  | TimeOffRequest has been updated.                 |
| TimeOffRequest          | Approved | TimeOffRequest has been approved.                |
| TimeOffRequest          | Denied   | TimeOffRequest has been denied.                  |
| DashboardOrderItems     | Updated  | DashboardOrderItems have been updated.           |
| BrandData               | Updated  | BrandData has been updated.                      |
| Divisions               | Created  | Division has been created.                       |
| Divisions               | Updated  | Division has been updated.                       |
| KYCStatus               | Updated  | Client KYC/KYB status has been updated.          |
| TransactionFileStatus   | Updated  | Transaction file status has been updated.        |
| TransactionReturnStatus | Updated  | Returns on a transaction file have been updated. |
| Position                | Created  | Position has been created.                       |
| Position                | Updated  | Position has been updated.                       |
| WCCode                  | Created  | Workers' Compensation Code has been created.     |
| WCCode                  | Updated  | Workers' Compensation Code has been updated.     |
| WCCodeRateTable         | Created  | WCCode Rate Table has been created.              |
| WCCodeRateTable         | Updated  | WCCode Rate Table has been updated.              |
| ClientPayCode           | Created  | Client Earning/Pay Code has been created.        |
| ClientPayCode           | Updated  | Client Earning/Pay Code has been updated.        |
| EeOnbTemplate           | Created  | Employee onboarding template has been created.   |
| EeOnbTemplate           | Updated  | Employee onboarding template has been updated.   |
| TOGroup                 | Created  | Time Off Group has been created.                 |
| TOGroup                 | Updated  | Time Off Group has been updated.                 |
| BEGroup                 | Created  | Benefits Group has been created.                 |
| BEGroup                 | Updated  | Benefits Group has been updated.                 |