Realtime operations

Publish live events, stream them to clients and read their counters.

Docs menu

realtime

realtime.publish

Publish a typed realtime event.

Route
MCP and CLI only
Auth
App key or user session; your security rules apply none
CLI
substrio op realtime.publish

Parameters

No parameters.

Response

A JSON object.

Errors

A failed call answers the error envelope with a typed code.

Example

substrio op realtime.publish

realtime.stats

Read realtime state.

Route
GET /v1/realtime/stats
Auth
App key or user session; your security rules apply none
CLI
substrio op realtime.stats

Parameters

No parameters.

Response

A JSON object.

Errors

A failed call answers the error envelope with a typed code.

Example

curl "$SUBSTRIO_URL/v1/realtime/stats" \
  -H "Authorization: Bearer $SUBSTRIO_KEY"

realtime.stream

Subscribe to typed realtime events.

Route
GET /v1/realtime
Auth
App key or user session; your security rules apply none
CLI
substrio op realtime.stream

Parameters

No parameters.

Response

A JSON object.

Errors

A failed call answers the error envelope with a typed code.

Example

curl "$SUBSTRIO_URL/v1/realtime" \
  -H "Authorization: Bearer $SUBSTRIO_KEY"