Event REST API
Events are exposed in two ways:
- Runtime event streams under aggregate-scoped endpoints
- Event metadata through
/api/dereg/events...
Runtime Event Stream
Section titled “Runtime Event Stream”| Method | Route |
|---|---|
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
Event Metadata
Section titled “Event Metadata”| Method | Route |
|---|---|
GET | /api/dereg/events |
GET | /api/dereg/events/{name} |
GET | /api/dereg/events/{name}/fields |
These endpoints return event-definition metadata.
Creating Events
Section titled “Creating Events”Event definitions can be registered through the optional schema API:
| Method | Route |
|---|---|
POST | /api/deql/create |
Requirements:
- Request contains a DeQL
CREATE EVENT ...statement
- There is no direct
POST /api/eventsendpoint. - Event emission happens as a side effect of command execution through decisions.