Stream live events (Server-Sent Events)

GET

/v1/events

const url = 'http://127.0.0.1:8080/v1/events?types=action.*%2Cdeed.sealed&last_event_id=7f3k2m.1842';
const options = {
  method: 'GET',
  headers: {'Deedglass-Version': '2026-10-01', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://127.0.0.1:8080/v1/events?types=action.*%2Cdeed.sealed&last_event_id=7f3k2m.1842' \
  --header 'Authorization: Bearer <token>' \
  --header 'Deedglass-Version: 2026-10-01'

What Postgres committed in your org, in commit order, as text/event-stream (docs/EVENTS.md). A Console session (viewer and up) or an org admin key sees the whole org; an agent key needs actions:read and sees only its own agent’s actions, approvals and deeds. The stream starts with retry: 3000, then event: hello, then one message per event: id: <instance>.<seq> (the stream cursor, not the evt_ id), event: <type> and data: the event object, which is exactly the webhook envelope (object, id, type, api_version, created_at, livemode, org, data.object) plus hydrated. When hydrated is true, data.object is the object in the shape its REST list returns (deed.sealed carries a deed_summary); otherwise it is the thin webhook object. Events never carry request or result payloads, approval context or email addresses. A : ping comment comes every 15 s when nothing else does; the server closes the stream after 30 minutes (reconnect with the last cursor). The credential is checked again every 60 s; when it is no longer valid, event: session_ended carries the error code and message, and the stream closes. Whenever you may have missed events (a cursor this instance can’t serve, the server’s connection to Postgres reconnected, or your client fell behind), event: resync names the reason: refetch your lists. Resume is best effort, within about 5 minutes on the same instance. Filters and cursors are checked before the first byte; a bad one is a 400 envelope. More than 8 open streams for one person or key is 429 rate_limited.

Authorizations

bearerAuth
sessionCookie

Parameters

Header Parameters

Deedglass-Version

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

The API version (YYYY-MM-DD). Leave it out to use your org’s pinned version (public routes use the latest). An unknown version is 400 api_version_invalid.

Last-Event-ID

string

The last id: you received; EventSource sends it on reconnect.

Query Parameters

types

string

<= 1200 characters

A comma list of event types or family wildcards: action.*,deed.sealed. Default every type.

Example

action.*,deed.sealed

agent

string

/^agt_[0-7][0-9a-hjkmnp-tv-z]{25}$/

Only this agent’s events. An agent key may name only its own agent.

last_event_id

string

/^[0-9a-z]{1,32}\.[0-9]{1,19}$/

The last id: you received, to resume (for clients that can’t set Last-Event-ID; the header wins).

Example

7f3k2m.1842

Responses

200

The stream. Messages: hello (StreamHello), one per event (Event), resync (StreamResync), session_ended (StreamSessionEnded), and : ping comments.

text/event-stream

Server-Sent Events; each data line is one JSON object of the schemas named above.

string

Examples

A hello, then an action event

retry: 3000

id: 7f3k2m.1841
event: hello
data: {"object":"stream","instance":"7f3k2m","resumed":false,"heartbeat_s":15,"server_time":"2026-10-08T14:02:09.100Z"}

id: 7f3k2m.1842
event: action.witnessed
data: {"object":"event","id":"evt_01k6h7mz3c9d8e7f6g5h4j3k2m","type":"action.witnessed","api_version":"2026-10-01","created_at":"2026-10-08T14:02:09.512Z","livemode":false,"org":"org_01k6h7kp6msmzrhdzwtcr3jnkp","hydrated":true,"data":{"object":{"object":"action","id":"act_01k6h7mz3c9d8e7f6g5h4j3k2m","state":"witnessing"}}}

: ping

The client may have missed events

id: 7f3k2m.1900
event: resync
data: {"object":"resync","reason":"cursor_expired"}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version

string

The API version this response follows.

default

An error. Every error has this envelope; doc_url explains the code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error

code

required

string

Allowed values: invalid_api_key api_key_revoked api_key_expired agent_suspended agent_stopped org_stopped insufficient_scope policy_denied approval_required approval_expired budget_exceeded intent_required intent_invalid intent_replay tool_unknown connector_unavailable upstream_error timeout rate_limited idempotency_conflict validation_failed not_found conflict internal_error authentication_required method_not_allowed request_too_large unsupported_media_type invalid_json api_version_invalid idempotency_key_invalid idempotency_key_in_use service_unavailable session_expired csrf_failed insufficient_role login_link_invalid login_code_invalid last_owner policy_unavailable policy_invalid credentials_missing destination_blocked vault_unavailable upstream_auth_failed upstream_not_found upstream_rate_limited response_too_large statement_refused row_limit_exceeded database_role_unsafe database_not_ready witness_not_configured approval_decided already_countersigned approver_not_eligible self_approval approval_needs_person context_changed approval_unsatisfiable approval_link_invalid approval_link_review_only approver_unmapped stripe_live_key_refused stripe_livemode_detected upstream_approval_pending schedule_needs_approval action_executing from_denied undo_unavailable undo_plan_stale already_undone undo_conflict replay_too_large replay_window_invalid suggestion_stale shadow_slot_taken suggestion_decided observe_not_enabled pro_required

message

required

One or more calm sentences with the next step.

string

param

required

The request field, query parameter or header the error is about.

string | null

request_id

required

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

doc_url

required

string format: uri

diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

One finding about a policy file, with its position and the next step. Codes are stable and listed in docs/POLICY_ERRORS.md. In the policy_invalid error envelope each diagnostic also carries object: policy_diagnostic. The full PolicyDiagnostic schema is in openapi.yaml.

object

action

One agent action. Its sections mirror the deed’s. status is the one field an agent needs; state is the exact lifecycle state (docs/GATE.md). The Gate’s own responses (POST /v1/actions and its result report) add execution.result and witness.reasons; lists leave both out. The full Action schema is in openapi.yaml.

object

checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "There's no endpoint at GET /v1/helth. Did you mean /v1/health?",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/not_found"
  }
}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version

string

The API version this response follows.