Skip to navigation

Events

All webhook event types and when they are triggered.

Events follow the naming convention {resource}.{action}.

Enrollment

EventDescription
enrollment.acceptedAn enrollment has been accepted. Learn more
enrollment.terminatedAn enrollment has been terminated. Learn more
enrollment.electedAn employee has elected a benefit. Learn more
enrollment.grantedAn enrollment has been granted. Learn more
enrollment.waivedAn employee has waived a benefit. Learn more
enrollment.startedAn enrollment has started. Learn more

Employee

EventDescription
employee.eligibility_grantedAn employee has been granted benefits eligibility. Learn more
employee.eligibility_terminatedAn employee’s benefits eligibility has been terminated. Learn more
employee.deactivatedAn employee has been deactivated. Learn more
employee.deduction_createdA new payroll deduction has been generated for an employee. Learn more

Understanding Event Flows

The diagram below shows how all webhook events relate to each other across resource types. Each event is grouped by its resource.

alt [Employee enrolls] [Employee declines] Census sync employees employee.eligibility_granted (per employee) enrollment.started enrollment.elected + enrollment.accepted enrollment.waived employee.deduction_created (per employee) employee.eligibility_terminated enrollment.terminated (per enrollment) employee.deactivated Employee opens enrollment Monthly deduction cycle (1st of each month) If employee is later terminated Partner Vitable API

Event flow summary:

  • Employee eligibility events (employee.eligibility_granted, employee.eligibility_terminated) signal when employees can or can no longer enroll.
  • Enrollment events track the full benefit selection lifecycle from enrollment.started through enrollment.accepted or enrollment.waived.
  • Payroll deductions (employee.deduction_created) are generated on a monthly schedule for employees with active enrollments.
  • Employee deactivation (employee.deactivated) occurs after termination and may trigger enrollment terminations.