cadenya-widgets conversations stream-events _123

{
  "type": "userMessage",
  "userMessage": {
    "content": "<string>"
  },
  "id": "<string>",
  "conversationId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

Events

Stream conversation events

Server-sent events for a conversation. Durable event IDs are Last-Event-ID resume checkpoints; live heartbeat/control frames never advance them. Token expiry leaves a healthy stream open. Session revocation, hard expiry, and exhaustion stop delivery and close the stream within 10 seconds; the server attempts a session-ended control event whose data is a google.rpc.Status with WidgetSessionErrorInfo, without an id. If delivery fails, reconnect returns the same structured terminal reason. Reconnect uses current credentials and rechecks conversation authorization. See the widget session lifecycle contract for in-flight action and replacement-session policy.

GET

/

v1

/

conversations

/

{id}

/

events:stream

cadenya-widgets conversations stream-events _123

{
  "type": "userMessage",
  "userMessage": {
    "content": "<string>"
  },
  "id": "<string>",
  "conversationId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string

required

Conversation ID.

Response

A stream of Server-Sent Events

WidgetEvent is the visitor-facing event vocabulary. It MIRRORS the internal conversation event variants — same granularity, same discriminator names — with slimmed messages holding exactly what a widget UI needs. Internal events map to these through an explicit, exhaustive server-side projection; internal-only types (context compaction, memory reads, sub-agent bookkeeping) have no widget variant and are dropped. Nothing here carries tool configuration, server identities, operator details, or internal error strings. Tool arguments cross this boundary only when an enabled tool set overlay explicitly opts the matching tool in.

type

enum<string>

required

Available options:

userMessage

userMessage

object

required

WidgetUserMessageEvent is a message from the visitor.

Show child attributes

id

string

required

read-only

Unique event id (prefixed ULID). Only durable objevt_ IDs are emitted as SSE id: fields and accepted as Last-Event-ID reconnect cursors. Transient heartbeats carry hb_ IDs in this payload only.

conversationId

string

required

read-only

The conversation this event belongs to.

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

createdAt

string<date-time>

required

read-only