Gateway WebSocket RPC methods
This client mirrors and verifies upstream-compatible behavior. Upstream runtimes remain the canonical protocol owners.
These methods dispatch over the gateway JSON-RPC WebSocket transport ({{gatewayWsUrl}}/api/ws), not over REST — so every operation's **HTTP** line is the RPC method name, not a path. OpenClawWebSocketClient keeps the authenticated OpenClaw gateway handshake and exposes subscribe(listener), request(method, params, { signal }), and dispose(); cancelling one request does not unsubscribe other listeners. Native Workboard methods are surfaced by the provider-agnostic KanbanClient (@cavi-ai/api-client/core/kanban); the OpenClaw Workboard adapter maps its canonical card/status types onto the RPC calls below. Method names mirror the upstream OpenClaw contract.
<!-- Workboard — cards -->
workboard.cards.list
List native Workboard cards, optionally scoped by board.
workboard.cards.export
Export card data.
workboard.cards.diagnostics
Read Workboard diagnostics.
workboard.cards.stats
Read Workboard card status/priority stats.
workboard.cards.runs
Read Workboard-linked run data.
workboard.cards.create
Create a Workboard card.
workboard.cards.update
Patch card fields.
workboard.cards.move
Move a card to another Workboard status.
workboard.cards.delete
Delete a card.
workboard.cards.comment
Add a card comment.
workboard.cards.link
Link a card to an external object.
workboard.cards.linkDependency
Link card dependency relationships.
workboard.cards.proof
Attach proof metadata to a card.
workboard.cards.artifact
Attach artifact metadata to a card.
workboard.cards.claim
Claim a card for an agent/operator.
workboard.cards.heartbeat
Send card worker heartbeat.
workboard.cards.release
Release a claimed card.
workboard.cards.promote
Promote a card through Workboard flow.
workboard.cards.reassign
Reassign a card.
workboard.cards.reclaim
Reclaim a stale card.
workboard.cards.complete
Complete a card.
workboard.cards.block
Block a card.
workboard.cards.unblock
Unblock a card.
workboard.cards.bulk
Apply bulk card operations.
workboard.cards.diagnostics.refresh
Refresh Workboard diagnostics.
workboard.cards.dispatch
Dispatch queued Workboard card work.
workboard.cards.specify
Specify card work.
workboard.cards.decompose
Decompose card work.
workboard.cards.archive
Archive a card.
<!-- Workboard — boards -->
workboard.boards.list
List Workboard boards.
workboard.boards.upsert
Create or update a board.
workboard.boards.archive
Archive a board.
workboard.boards.delete
Delete a board.
<!-- Workboard — notifications -->
workboard.notifications.subscribe
Subscribe to Workboard notifications.
workboard.notifications.list
List Workboard notifications.
workboard.notifications.delete
Delete a Workboard notification.
workboard.notifications.events
Read Workboard notification events.
workboard.notifications.advance
Advance notification cursor/state.
<!-- Workboard — attachments -->
workboard.cards.attachments.list
List card attachments.
workboard.cards.attachments.get
Fetch a card attachment.
workboard.cards.attachments.add
Add a card attachment.
workboard.cards.attachments.delete
Delete a card attachment.
<!-- Workboard — workers -->
workboard.cards.workerLog
Append Workboard worker log data.
workboard.cards.protocolViolation
Record a worker protocol violation.
<!-- System -->
health
Core health RPC.
health.snapshot
Legacy health snapshot fallback.
status
OpenClaw status RPC.
logs.tail
Tail gateway logs.
<!-- Agent -->
agent.wait
Wait for agent readiness.
<!-- Config -->
config.get
Fetch runtime config.
config.schema
Fetch runtime config schema.
<!-- Catalog -->
models.list
List models.
commands.list
List commands.
tools.catalog
List available tools.
agents.list
List agents.
<!-- Sessions -->
sessions.list
List sessions.
sessions.preview
Fetch compact session previews.
sessions.describe
Describe a session.
sessions.usage
Fetch session usage data.
sessions.create
Create a session.
sessions.resolve
Resolve a session key.
sessions.send
Send to a session.
sessions.steer
Steer session behavior.
sessions.abort
Abort session work.
sessions.patch
Patch session settings.
<!-- Chat -->
chat.send
Send a chat message.
chat.abort
Abort chat work.
<!-- CAVI Operator -->
operator.status
Fetch CAVI operator status.
operator.registry.get
Fetch CAVI operator registry.
operator.snapshot
Fetch CAVI operator snapshot.
operator.memory.list
List operator memory entries.
operator.tasks.list
List operator tasks.
operator.tasks.get
Fetch operator task detail.
discourse.tree
Fetch discourse tree.
operator.worker.ready
Fetch worker readiness.
operator.worker.tasks.list
List worker tasks.
operator.worker.tasks.get
Fetch worker task detail.