Skip to content
You are viewing docs for v0.1.0. Switch to latest

Event REST API

Events are exposed in two ways:

  1. Runtime event streams under aggregate-scoped endpoints
  2. Event metadata through /api/dereg/events...
MethodRoute
GET/api/aggregates/{agg}/events
GET/api/aggregates/{agg}/events/{stream_id}

These endpoints return Arrow IPC rows from DeReg."{agg}$Events".

Typical event columns include:

  • stream identity
  • sequence number
  • event type
  • event payload data
MethodRoute
GET/api/dereg/events
GET/api/dereg/events/{name}
GET/api/dereg/events/{name}/fields

These endpoints return event-definition metadata.

Event definitions can be registered through the optional schema API:

MethodRoute
POST/api/deql/create

Requirements:

  • Request contains a DeQL CREATE EVENT ... statement
  • There is no direct POST /api/events endpoint.
  • Event emission happens as a side effect of command execution through decisions.