Available Webhooks

This section lists down all available webhook events that partners can subscribe to along with their specific prereqs.

Webhook	Trigger prereq	Trigger condition
company.activated	Before company is active	When a company becomes active
company.archived	At any time	When a company is archived
company.eor_hiring.additional_information_required	After first EOR hiring starts	When additional information is required to expedite hiring checks.
company.eor_hiring.reserve_payment_requested	After first EOR hiring starts	When a request comes in to provide reserve payment to proceed with hiring an employee.
company.eor_hiring.no_reserve_payment_requested	After first EOR hiring starts	When no request is issued to provide reserve payment in order to hire an employee.
company.eor_hiring.referred	After first EOR hiring starts	When a company's credit risk status is referred.
company.eor_hiring.verification_completed	After first EOR hiring starts	When company verification is complete.
company.manager_created	At any time	When a new company manager has been created
company.manager_updated	At any time	When a company manager's profile is updated
company.manager_deleted	At any time	When a company manager's profile is deleted
contract_amendment.submitted	For an active employment	When a change in employment contract is submitted for review
contract_amendment.review_started	For an active employment	When an admin starts reviewing a contract amendment request
contract_amendment.done	For an active employment	When a contract amendment request has been approved
contract_amendment.canceled	For an active employment	When a contract amendment request has been canceled
contract_amendment.deleted	For an active employment	When a contract amendment request is deleted from the records
custom_field.value_updated	At any time	When a custom field's value is updated.
employment.account.updated	After employment invitation has been sent	When an employee's email account is updated.
employment.employment_agreement.available	During employee self enrollment	When employment agreement is available for a user to review and sign.
employment_company_structure_node.updated	After employment is active	When an employee's company structure node is update. This refers to any change in the employee's placement in the company's hierarchy.
employment_contract.active_contract_updated	After employment is active	When a new contract becomes active for an employment.
employment_contract.adjusted_during_onboarding	Before employment is active	When an employment contract is changed during employee's onboarding.
employment.administrative_details.updated	During employee self enrollment	When administrative details of an employee are updated.
employment.details.updated	After employment creation	When an employee's department or manage records are updated.
employment.work_email.updated	After employment creation	When an employee's work email is updated in the records.
employment.personal_information.updated	During and after employee self enrollment	When an employee's personal information is changed.
employment.eor_hiring.proof_of_payment_accepted	After employment creation	When proof pf payment is accepted during EOR hiring process.
employment.no_longer_eligible_for_onboarding_cancellation	During employee self enrollment	When an employee 's onboarding can no longer be cancelled.
employment.onboarding.started	After employment invitation has been sent	When an employee's onboarding officially starts.
employment.onboarding.completed	After employment invitation has been sent	When an employee's onboarding is fully completed, meaning all user tasks are completed and user status is also active.
employment.onboarding.cancelled	After employment invitation has been sent	When an employee's onboarding is successfully cancelled.
employment.onboarding_task.completed	During employee self-enrollment	When each onboarding task is completed by the employee during self-enrollment
employment.probation_completion_letter.submitted	When employment is active	When a request comes in for an employee's probation completion letter.
employment.probation_completion_letter.completed	When employment is active	When an employee's probation completion letter request is completed.
employment.probation_completion_letter.cancelled	When employment is active	When an employee's probation completion letter request is cancelled.
employment.probation_period_extension.submitted	When employment is active	When a request comes in to extend an employee's probation period.
employment.probation_period_extension.completed	When employment is active	When the request to extend an employee's probation period is approved.
employment.probation_period_extension.cancelled	When employment is active	When the request to extend an employee's probation period is cancelled.
employment.probation.period_ending_reminder_sent	When employment is active	When an employee's probation period is due to end in 30 days and before 7 days.
employment.start_date.changed	After employment creation	When an employer changed an employment's start date.
employment.user_status.activated	After employment creation	When a user's employment status becomes active.
employment.user_status.deactivated	When an employment is active	When a user's employment status changes to deactivated.
employment.user_status.initiated	On employment creation	When an employment status changes to `initiated`.
employment.user_status.invited	On employment creation	When an employee is invited to self-enrollment and its user status changes to invited.
employment.eor_hiring.invoice_created	After first EOR hiring starts	When EOR hiring invoice is created.
expense.created	When employment is active	When a draft expense is created.
expense.approved	When employment is active	When an expense is approved by the employer.
expense.declined	When employment is active	When an expense is declined by the employer.
expense.deleted	When employment is active	When an expense is deleted by a team member or an admin.
expense.reimbursed	When employment is active	When an expense is reimbursed.
expense.submitted	When employment is active	When an expense is submitted by the employee.
expense.updated	When employment is active	When an expense is updated.
identity_verification.verification_required	When employment is active	When an identity verification is needed for an employment.
incentive.created	When employment is active	When a new incentive is created.
incentive.processing_started	When employment is active	When an incentive payment processing begins.
incentive.paid	When employment is active	When an incentive payment is completed.
incentive.updated	When employment is active	When an incentive is modified.
incentive.deleted	When employment is active	When an incentive is deleted.
offboarding.submitted	When employment is active	When an offboarding request is submitted.
offboarding.review_started	When employment is active	When an ofbfoarding request' review starts and the request status changes to `in_review`.
offboarding.submitted_to_payroll	When employment is active	When an admin submits the offboarding to payroll.
offboarding.completed	When employment is active	When an offboarding status changes from `pending_payment` to `completed` after payroll processes final payment, indicating that employment offboarding is complete.
offboarding.deleted	When employment is active	When an offboarding request is deleted.
payslip.released	When employment is active	When a payslip becomes available for employees.
sso_configuration.enabled	With an active company	When an SSO configuration is enabled.
sso_configuration.updated	With an active company	When an SSO configuration is updated.
sso_configuration.disabled	With an active company	When an SSO configuration is disabled.
timeoff.requested	When employment is active	When an employee submits a time off request.
timeoff.approved	When employment is active	When a time off request is approved by the employer.
timeoff.cancellation_requested	When employment is active	When an employee submits a time off cancellation request.
timeoff.date_changed	When employment is active	When the requested date is changed in a time off request.
timeoff.updated	When employment is active	When a time off request is updated.
timeoff.declined	When employment is active	When a time off request was declined by the employer.
timeoff.canceled	When employment is active	When a time off request is canceled by the employee.
timeoff.started	When employment is active	When the requested time off period starts.
timeoff.taken	When employment is active	When an approved time off request dates passes.
timesheet.submitted	When employment is active	When a timesheet is submitted by an employee.
travel_letter.requested	When employment is active	When a travel letter request is submitted by an employee.
travel_letter.approved_by_manager	When employment is active	When a travel letter approval request is approved by the manager.
travel_letter.approved_by_remote	When employment is active	When a travel letter approval request is approved by Remote.
travel_letter.declined_by_manager	When employment is active	When a travel letter approval request is declined by the manager.
travel_letter.declined_by_remote	When employment is active	When a travel letter approval request is declined by Remote.
work_authorization.requested	When employment is active	When a work authorization request is submitted by an employee.
work_authorization.approved_by_manager	When employment is active	When a work authorization request is approved by employee's manager.
work_authorization.approved_by_remote	When employment is active	When a work authorization request is approved by Remote.
work_authorization.declined_by_manager	When employment is active	When a work authorization request is declined by employee's manager.
work_authorization.declined_by_remote	When employment is active	When a work authorization request is declined by Remote.
work_authorization.cancelled	When employment is active	When a work authorization request is cancelled by the employee.
benefit_renewal_request.created	When employment is active	When a new benefit renewal request is created.
billing_document.issued	With an active company	When a new billing document (e.g. invoice or credit note) is issued to the company.