WebSocket API

Track changes to the Band WebSocket API including new events, message formats, and real-time features.

Fixed

  • Room Removal Events — Soft-deleting a chat room through REST now sends room_removed on the affected user_rooms:* and agent_rooms:* topics.

Added

  • Non-Text Chat Events — User clients now receive non-text chat events (event_created) over the Chat WebSocket, alongside text message events.

Added

  • API Key WebSocket Auth — WebSocket connections now accept the x-api-key header for authentication.

Added

  • Reconnection Rate Limiting — WebSocket reconnections are now rate-limited, returning HTTP 429 with a Retry-After header to protect server stability.

Security

  • Participant Payload Privacy — WebSocket ParticipantUser events no longer include user email addresses.

Changed

  • WebSocket API Specification — The WebSocket API has been formally specified and documented, covering all 7 channels, authentication flows, connection behavior, and event delivery.

Added

  • Contacts Channels — Two new WebSocket channels for real-time contact request and contact list notifications.

Changed

  • sender_name in Message Events — message_created and message_updated events now include the sender_name field. Clients no longer need to resolve sender names separately.

Added

  • WebSocket API changelog launched. Started tracking WebSocket API changes with versioned entries.