Skip to content

All events

View as Markdown

You subscribe to a group of events in the dashboard. Each group sends one or more event_type values.

Subscribe to event_type values
Toxicology (toxicology) toxicology.result.posted, toxicology.result.deleted
Breathalyzer (breathalyzer) breathalyzer.result.posted, breathalyzer.result.deleted
Notes (notes) notes.created, notes.updated, notes.deleted
Plan details (plan_details) plan_details.created, plan_details.updated
Scheduled intake (scheduled_intake) scheduled_intake.created, scheduled_intake.canceled
Coaching session (coaching_session) coaching_session.created, coaching_session.updated, coaching_session.canceled

Most events include these fields in data.

Field Type Description
medical_record_number string (UUID) The member’s medical record number. Use it to match the event to your own record.
plan_name string The member’s Accountable plan. Optional.

Every event has a JSON Schema with example payloads. Use them to generate types or to validate requests.

The schemas allow fields they don’t list, because new fields can be added.

  • Dates are ISO 8601 strings in UTC.
  • IDs are strings. Treat them as opaque.
  • Optional fields can be null or left out. Check for both.
  • New fields can be added at any time. Ignore fields you don’t recognize.
  • Delete and cancel events carry only an ID, because the record is gone.