Skip to main content
API reference sections

Schema

StoredEvent

One journaled event: the envelope plus what only the journal knows.

Type object

Shape

FieldTypeDescription
seqrequiredinteger (uint64, >= 0)

The delivery cursor. Totally ordered per journal, never reused.

recorded_at_msrequiredinteger (int64)

The journal's own clock at append - recorded - occurred is the delivery latency the debug flag prints.

enveloperequiredEnvelope

One event on the local bus.

Example
{
  "seq": 0,
  "recorded_at_ms": 0,
  "envelope": {
    "event_id": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "version": 0,
    "occurred_at_ms": 0,
    "actor": {
      "kind": "user",
      "id": "00000000-0000-4000-8000-000000000000",
      "token": "string"
    },
    "origin": {
      "device_id": "00000000-0000-4000-8000-000000000000",
      "session_id": {}
    },
    "scope": {
      "profile_id": "00000000-0000-4000-8000-000000000000",
      "workspace_id": "00000000-0000-4000-8000-000000000000"
    },
    "subject": {
      "kind": "workspace",
      "id": "string",
      "version": 0
    },
    "correlation_id": "00000000-0000-4000-8000-000000000000",
    "causation_id": "00000000-0000-4000-8000-000000000000",
    "attrs": {
      "key": {
        "t": "id",
        "v": "00000000-0000-4000-8000-000000000000"
      }
    }
  }
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.