Skip to main content
GET
Get an event

Authorizations

Authorization
string
header
default:Bearer sandbox_any_token_works
required

A brand's server, one OAuth client per brand and environment. Get a token with the client_credentials grant and send it as Authorization: Bearer <token>. Tokens last 1 hour. A brand server reads status and ids only; it never reads clinical content. A platform partner holds one client for all its brands and gets one token per brand, naming it with tenant_id.

Path Parameters

event_id
string<uuid>
required

Response

The event.

id
string<uuid>
required

Unique per event; the same on every retry. Dedupe on it.

Example:

"0190f5d8-4b2d-7e6f-8a21-c2d3e4f5a6b7"

type
enum<string>
required
Available options:
enrollment.created,
enrollment.stage_changed,
enrollment.paused,
enrollment.resumed,
enrollment.cancelled,
care_team.assigned,
care_team.changed,
care_team.capacity_warning,
care_team.feedback_due,
form.requested,
onboarding.completed,
protocol.published,
protocol.updated,
message.created,
clinical.flag_raised,
clinical.flag_redelivered,
clinical.flag_acknowledged,
clinical.flag_resolved,
patient.disengaged,
patient.milestone_reached,
reminder.due,
data_request.completed
Allowed value: "enrollment.created"
Example:

"enrollment.created"

created_at
string<date-time>
required

ISO 8601 in UTC.

Example:

"2026-10-26T14:05:00Z"

tenant_id
string<uuid>
required

Your tenant.

Example:

"a0000000-0000-4000-8000-000000000002"

data
object
required