Skip to content
OpenCode
Esc
navigateopen⌘Jpreview

Subscribe to events

Subscribe to native event payloads for the server. Volatile by contract: a slow consumer overflows and fails the stream, and events during disconnection are missed.

GET/api/event
Responses
200Success
idstring | anyrequired
Show properties
Any of:
string
string
any
any
eventstringrequired
dataV2EventStreamrequired
400InvalidRequestError
_tagstringrequired
Allowed:InvalidRequestError
messagestringrequired
kindstring | any
Show properties
Any of:
string
string
any
any
fieldstring | any
Show properties
Any of:
string
string
any
any
401UnauthorizedError
_tagstringrequired
Allowed:UnauthorizedError
messagestringrequired
Request
curl -X GET "/api/event"
Response
{
  "id": "string",
  "event": "string",
  "data": "string"
}