API reference
Events
/events
Posting an event is what makes Raven send. Types come from the High school pack and from your instance; GET /event-types is the truth for your instance.
GET/event-typesList types · pack plus instanceGET/event-types/{type_key}Read a type · with payload schemashown →POST/eventsRecord and judgeGET/eventsList · ?q ?subject_id ?subject_ref ?type_key ?voidedGET/events/{event_id}ReadPOST/events/{event_id}/voidVoid · calls off sends not yet gone
GETRead an event type
Requires events:read. Returns the type with its JSON Schema, so you can validate before you post.
Path parameters
type_keystring · required
e.g. absence.
Returns
200 with the event type as it is resolved in this instance. 404 not_found if the instance does not know the key.
Response body
One event type: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
iduuid
pack_idstring | nullSet on a type the pack defines.
tenant_iduuid | nullSet on a type this instance defined for itself. One of the two is always null.
keystringWhat type_key names.
labelstring
scopesubject | group | tenantWhich id an event of this type must carry.
payload_schemaobjectJSON Schema (draft 2020-12), closed: what POST /events checks payload against.Varies by pack
date_fieldstring | nullThe payload field that carries the event's date.
dedupe_fieldsstring[]The payload fields that make two occurrences one.
created_atdatetime
updated_atdatetime
On failure the body is { error, code } instead.