Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Response

200 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
notification_type
enum<string>
required

The type of notification. For example, welcome is created for new hires and enrollment_submitted after a member submits their enrollment.

Available options:
enrollment_submitted,
enrollment_approved,
member_terminated,
welcome,
newly_eligible,
dependent_age_out,
open_enrollment_kickoff,
open_enrollment_reminder

The type of the object this notification is about.

Available options:
member,
dependent,
employer,
open_enrollment_window,
payroll_benefit,
subclass,
enrollment,
business_unit,
beneficiary,
plan,
plan_configuration,
notification,
retirement_connection

ID of the object this notification is about, so you can look up more information if needed.

payload
object
required
read-only

Commonly used information for notifications of this type that can be populated into an email template.

owner
enum<string>
required

Who is responsible for delivering this notification to the recipient.

Available options:
clasp,
partner
created_at
string<date-time>
required
read-only