WEP WebHook Events
WEP WebHook requests always contain four items:
- CompanyId - ID of the company where the webhook was triggered.
- Action- Action Name.
- refId - ID of the entity. For example, on payroll actions, you will have the payroll run ID, which is usable for getting information about the payroll.
- Payload- an optional item, in most cases, empty.
Below is a list of WEP WebHooks events that you can register for in our system:
Event for All required data:
| Subscription Type | Events | Descriptions |
|---|---|---|
| WebHook | Test | WebHook has been tested. |
Events for All or Payroll required data:
| Subscription Type | Events | Descriptions |
|---|---|---|
| Payroll | Started OnTimeSheet Calculated Approved Locked Finalized | Payroll has started. Payroll run is now on TimeSheet. Payroll has been calculated. Payroll has been approved. Payroll has been locked. Payroll has been finalized and can't be discarded. |
Events for All or Employee required data:
| Subscription Type | Events | Descriptions |
|---|---|---|
| Employee | CreatedSystem (Back-Office Action Supported) UpdatedSystem (Back-Office Action Supported) TerminatedSystem (Back-Office Action Supported) Created Updated Terminated | Employee has been created in the system. Employee has been updated in the system. Employee has been terminated in the system. Employee has been created. Employee has been updated. Employee has been terminated. |
| PayAllocation | Created Updated Deleted PriorityUpdated | Net Pay Alloc has been created Net Pay Alloc has been updated Net Pay Alloc has been deleted Net Pay Alloc priority/order has been changed |
| ChildGarnishment | Created Updated | ChildGarnishment has been created. ChildGarnishment has been updated. |
| MiscDeduction | Created Updated | MiscDeduction has been created. MiscDeduction has been updated. |
| Benefit | Created Updated | Benefit has been created. Benefit has been updated. |
| Document | Created Signed | Document has been created. Document has been signed. |
| EmployeeTOR | Created Updated | EmployeeTOR has been created. EmployeeTOR has been updated. |
| DashboardEmployeeOrderItems | Updated | Employee Dashboard Order Items have been updated. |
| Onboarding | EeOnboardingEeFinishedPhase2 | Employee finished his part of onboarding |
| HRTEvent_ | Create Update Delete | HR Tracking Event Created HR Tracking Event Updated HR Tracking Event Deleted |
| W4 | Requested EeFinished | W4 change has been requested. W4 change has been finished by EE. |
Events for All or Client required data:
| Subscription Type | Events | Descriptions |
|---|---|---|
| Company | Created Updated | Company has been created. Company has been updated. |
| BankAccount | Created Updated | BankAccount has been created. BankAccount has been updated. |
| WorkLocation | Created Updated | WorkLocation has been created, WorkLocation has been updated. |
| Department | Created Updated | Department has been created. Department has been updated. |
| JobCostingSegment | Updated | JobCostingSegment has been updated. |
| JobCostingSegmentValue | Created Updated Removed | JobCostingSegmentValue has been created. JobCostingSegmentValue has been updated. JobCostingSegmentValue has been rmoved. |
| BenefitTemplate | Created Updated | BenefitTemplate has been created. BenefitTemplate has been updated. |
| TimeOffRequest | Created Updated Approved Denied | TimeOffRequest has been created. TimeOffRequest has been updated. TimeOffRequest has been approved. TimeOffRequest has been denied. |
| DashboardOrderItems | Updated | DashboardOrderItems have been updated. |
| BrandData | Updated | BrandDatea has been updated. |
| Divisions | Created Updated | Division has been Created 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 transaction file had been updated |
| Position | Created Updated | Position has been Created Position has been Updated |
| WCCode | Created Updated | Workers Compensation Code has been Created Workers Compensation Code has been Updated |
| WCCodeRateTable | Created Updated | WCCode Rate Table has been Created WCCode Rate Table has been Updated |
| ClientPayCode | Created Updated | Client Earning/PayCode has been Created Client Earning/PayCode has been Updated |
| EeOnbTemplate | Created Updated | EE onboarding template has been Created EE onboarding template has been Updated |
| TOGroup | Created Updated | Time Off Group has been Created Time Off Group has been Updated |
| BEGroup | Created Updated | Benefits Group has been Created Benefits Group has been Updated |
Sample payload for specific events
Updated 8 months ago
Did this page help you?