Create an event
/v1/eventsCreates an event and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff. Requires a key with write scope.
Headers
A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.
Request body
application/jsonShort summary.
What happened.
Category, as named in your agency's event types.
How serious it was.
LowMediumHighCriticalnullWhere follow-up stands.
OpenMonitoringAwaitingFollowUpResolvedClosednullWhen it happened.
The patient involved.
The caregiver involved.
The visit involved.
Attendance points this event counts for, if your agency uses a points policy.
What was done.
Outcome.
Whether follow-up is needed.
When follow-up is due.
Follow-up notes.
How it was resolved.
Whether only administrators can see it.
Response
201The new event.
String representing the object's type. Always event.
Unique identifier of the event.
Short summary.
What happened.
Category, as named in your agency's event types.
How serious it was.
LowMediumHighCriticalnullWhere follow-up stands.
OpenMonitoringAwaitingFollowUpResolvedClosednullWhen it happened.
The patient involved.
The caregiver involved.
The visit involved.
Attendance points this event counts for, if your agency uses a points policy.
What was done.
Outcome.
Whether follow-up is needed.
When follow-up is due.
Follow-up notes.
How it was resolved.
Whether only administrators can see it.
Who documented it.
When it was documented.
When it was resolved.
When the event was created.
When the event was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 409 | n/a | The Idempotency-Key was already used with a different request, or that request is still running (idempotency_conflict). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.