The centralized log of domain events across every domain, as CloudEvents 1.0 envelopes. Supports REST polling and a live stream, and keeps a permanent audit history whether or not a message broker is in use.
Publishing records an event a domain producer emits. It is for systems recording what happened, not for requests made on a person's behalf.
https://api.example.com/platformEvents
Centralized event log across all domains.
▶
GET
/events
List events
#
Queryable log of all domain events across the blueprint. Supports REST polling as an integration pattern and provides permanent audit history regardless of whether a message broker is in use.
Events are returned in ascending time order (oldest first) to support cursor-based polling.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| ▶q | string | query | Search query using field:value syntax. Multiple conditions separated by | |
| ▶sort | string | query | Comma-separated list of fields to sort the response by. Prefix a field | |
| ▶type | string | query | Filter by CloudEvents type. Supports prefix matching with a trailing wildcard (e | |
| ▶source | string | query | Filter by CloudEvents source (the domain that produced the event, e.g., `/intake | |
| ▶subject | string | query | Filter by CloudEvents subject — the entity ID the event pertains to. Because eve | |
| traceid | string | query | Filter by W3C Trace Context trace ID extracted from the |
|
| causationid | string | query | Filter by the |
|
| start | string | query | Return only events at or after this timestamp (ISO 8601). |
|
| end | string | query | Return only events before or at this timestamp (ISO 8601). |
|
| limit | integer | query | Maximum number of items to return (1-100). |
|
| offset | integer | query | Number of items to skip before collecting results. |
▶
POST
/events
Publish an event
#
Publish a CloudEvents 1.0 envelope to the event log. Used by domain producers to record state transitions and significant data mutations.
▶
GET
/events/stream
Stream domain events (SSE)
#
Real-time stream of domain events delivered as Server-Sent Events (SSE).
Connect with Accept: text/event-stream. Each event is one SSE message: an id: line with the event's id, and a data: line with the JSON-encoded Event.
To pick up after a dropped connection, reconnect with the last id received in Last-Event-ID, as a browser's EventSource does on its own: the stream first sends every matching event after that one, in the order they happened, then carries on live. An id the log no longer has is answered 410 Gone, so a reader never quietly misses events; it reads what it needs afresh and connects again without one.
The filters are the ones listing events takes.
A server that can't hold a connection open — behind an API gateway that ends requests early, say — may leave the stream out and answer 501. Readers then poll listing events, with the same filters and start, which every server serves.
The stream stays open until the client disconnects. A : heartbeat comment is sent every 30 seconds to prevent proxy timeouts.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| ▶type | string | query | Filter by CloudEvents type. Supports prefix matching with a trailing wildcard (e | |
| ▶source | string | query | Filter by CloudEvents source (the domain that produced the event, e.g., `/intake | |
| ▶subject | string | query | Filter by CloudEvents subject — the entity ID the event pertains to. Because eve | |
| Last-Event-ID | string | header | The |
▶
GET
/events/{eventId}
Get a domain event
#
Retrieve a single domain event by its identifier.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| eventId | string | path | ✓ | Unique identifier of the domain event. |