AsyncAPI channel · Stream
· Stream Chat Realtime WebSocket API
/connect
The single multiplexed WebSocket channel. After the handshake, the server
pushes all real-time events for the connected user across every channel
they watch, and the client publishes keep-alive `health.check` events.
Connection keep-alive; the first one carries the connection_id.
Content-Type: application/json
message.new
A new message was sent to a channel the user watches.
Content-Type: application/json
message.updated
Message updated
Content-Type: application/json
message.deleted
Message deleted
Content-Type: application/json
message.read
A user marked a channel read; unread counts changed.
Content-Type: application/json
reaction.new
New reaction
Content-Type: application/json
typing.start
Typing started
Content-Type: application/json
typing.stop
Typing stopped
Content-Type: application/json
user.presence.changed
A watched user's online/offline presence changed.
Content-Type: application/json
user.watching.start
User started watching a channel
Content-Type: application/json
notification.message_new
A new message arrived in a channel the user is a member of but is not currently watching.
Content-Type: application/json
notification.added_to_channel
Notification - added to a channel
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.