Skip to content

docs(api): Document WebSocket event subscription types and payload formats #1301

Description

@kike-alt

Context

Real-time WebSocket Gateway events require documented channel names and payload interfaces.

Acceptance criteria

  • Document WebSocket channels (e.g., sessionUpdated, guessResult) in docs/WEBSOCKET_API.md.
  • Include TypeScript interface definitions for emitted event payloads.
  • Document socket authentication handshake procedure.

Implementation notes

Create docs/WEBSOCKET_API.md documentation file.

Metadata

Metadata

Labels

DocumentationImprovements or additions to documentationStellar WaveIssues in the Stellar wave programapiwebsocket

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions