Concepts
Instances and packs
An organisation owns one or more Raven instances. Each instance runs exactly one pack. The pack is data, not code: it decides what the nouns are called, which attributes they carry and which event types exist.
Organisation
one Account organisation
Instance
/t/lincoln-high
Instance
/t/lincoln-junior
Pack · High school
highschool
Pack · Political party
political_party
One key reaches the instances chosen at creation. A key for one instance cannot read another, or find out that it exists.
Fixed across packs
Paths — /contacts /subjects /links /events /messagesField names — subject_id, contact_id, type_keyScopes — subjects:write is always subjects:writeAuth, errors, pagination, rate limits
Varies by pack
Labels — Parent, Student, ClassThe attributes object on each resourceThe list of event types and each payloadAllowed relationship values
Your instance may define event types of its own. The pack is the baseline. GET /event-types is the truth for your instance.