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 TypeEventsDescriptions
WebHookTestWebHook has been tested.

Events for All or Payroll required data:

Subscription Type

Events

Descriptions

Payroll

Finalized (Back-Office Action Supported)
Started
OnTimeSheet
Calculated
Approved

Payroll has been finalized.
Payroll has started.
Payroll run is now on TimeSheet.
Payroll has been calculated.
Payroll has been approved.

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

Updated

PayAllocation has been updated.

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

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
Removed

Sample payload for specific events