Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

A benefit event is what opens an enrollment window — annual open enrollment for a whole entity, or a new hire or qualifying life event (QLE) for a single worker. It points at the program the window opens into, carries the event date (the point: hire date, QLE date, or the open-enrollment effective date), and the starts/ends of the window itself. An open-enrollment event fans out one enrollment per eligible worker; a new-hire or QLE event opens one.

Attributes

id
string
Unique identifier for the event, e.g. benev_K2mP9qR4xL7s.
object
string
The object type. Always benefit.event.
program
string
ID of the program the window opens into.
entity
string | null
ID of the entity, set for an entity-wide open enrollment. Null for a worker-specific event.
worker
string | null
ID of the worker, set for a new-hire or QLE event. Null for an entity-wide event.
type
string
What opened the window. One of open_enrollment, new_hire, qle, or termination.
subtype
string | null
For a qle, the qualifying reason — e.g. marriage, newborn, divorce, adoption, lost_coverage. Null for other types.
date
string
The event point — the hire or QLE date, or the open-enrollment effective date.
starts
string | null
First day the enrollment window is open.
ends
string | null
Last day the enrollment window is open.
metadata
object
Set of key-value pairs attached to the event.
created
string
Timestamp of when the event was created.
updated
string
Timestamp of when the event was last updated.