Alerts
Alerts on your agency's alert board, such as a credential about to expire or a missed clock-in, and announcements staff post for caregivers.
Endpoints
The Alert object
object
stringread-only
String representing the object's type. Always alert.
id
stringread-only
Unique identifier of the alert.
name
string | nullmax length 200
Headline.
description
string | nullmax length 20000
Details.
type
string | null
How prominently the alert is shown.
One of
CriticalImportantNoticenullaudience
string | null
Who sees the alert. Caregiver, Patient, Visit and PatientCareTeam need audienceTargetId.
One of
CompanyWideStaffOnlyCaregiversAllPatientsAllCaregiverPatientVisitPatientCareTeamnullaudienceTargetId
string | nullmax length 64
The caregiver, patient or visit the alert is for, when the audience names one.
time
string · date-time | null
When the alert takes effect.
reviewDate
string · date-time | null
When the alert should be reviewed or cleared.
createdAt
string · date-time | nullread-only
When the alert was created.
updatedAt
string · date-time | nullread-only
When the alert was last changed.