Events
3 endpoints
POST /api/v5/events/poll
Poll Events
Validate an artifact event subscription and reserve the delivery shape.
TODO: Read persisted call/domain events from the canonical store once wired.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
artifact: `string`
operation: `string`
entity_id?: `string` | `null`
cursor?: `string` | `null`
types?: `string`[] | `null`
limit?: `integer`
}Response:
{
events: `EventEnvelope`[]
next_cursor?: `string` | `null`
previous_cursor?: `string` | `null`
}GET /api/v5/events/stream
Stream Events
Stream artifact events via SSE using the centralized declaration registry.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
artifact | query | Yes | — |
operation | query | Yes | — |
entity_id | query | No | — |
cursor | query | No | — |
types | query | No | — |
limit | query | No | — |
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Response:
`any`POST /api/v5/events/webhooks/dispatch
Dispatch Webhook Events
Dispatch artifact events to a webhook target resolved from a license key.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
artifact: `string`
operation: `string`
license_key: `string`
entity_id?: `string` | `null`
cursor?: `string` | `null`
types?: `string`[] | `null`
limit?: `integer`
}Response:
{
success: `boolean`
delivered_count: `integer`
target_url: `string`
next_cursor?: `string` | `null`
}Last updated on