Skip to content
Vitable Docs Vitable Docs Vitable Docs
Webhooks
Events

Events

All webhook event types and when they are triggered.

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

Enrollment

Section titled “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

Section titled “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

Employer

Section titled “Employer”
EventDescription
employer.eligibility_policy_createdAn eligibility policy has been created for an employer. Learn more

Understanding Event Flows

Section titled “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.

sequenceDiagram
    participant P as Partner
    participant V as Vitable API
    P->>V: Create eligibility policy
    V--)P: employer.eligibility_policy_created
    P->>V: Census sync employees
    V--)P: employee.eligibility_granted (per employee)
    Note over V: Employee opens enrollment
    V--)P: enrollment.started
    alt Employee enrolls
        V--)P: enrollment.elected + enrollment.accepted
    else Employee declines
        V--)P: enrollment.waived
    end
    Note over V: Monthly deduction cycle (1st of each month)
    V--)P: employee.deduction_created (per employee)
    Note over V: If employee is later terminated
    V--)P: employee.eligibility_terminated
    V--)P: enrollment.terminated (per enrollment)
    V--)P: employee.deactivated

Event flow summary:

  • An eligibility policy (employer.eligibility_policy_created) sets the rules for when employees become eligible.
  • 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.
Section titled “Related Resources”