AsyncAPI channel · Stream
· Stream Chat WebSocket API
/connect
Single WebSocket channel that multiplexes every Stream Chat event for the
connected user across all channels they watch. The first frame after a
successful handshake is a `health.check` event carrying the connection_id
and the authenticated user's `me` payload.
Client-originated events sent over the same socket.
subscribe
receiveChatEvent
Receive events from Stream Chat.
Messages
TypingStartEvent
A user has started typing in a channel.
Content-Type:
TypingStopEvent
A user has stopped typing in a channel.
Content-Type:
CustomEvent
Any custom event published to a channel via `channel.sendEvent`.
Content-Type:
HealthCheckEvent
Periodic keep-alive ping delivered roughly every 30 seconds; also the first frame after connect.
Content-Type:
ConnectionChangedEvent
Local WebSocket connection state has changed (online/offline).
Content-Type:
ConnectionRecoveredEvent
WebSocket has finished reconnecting and is healthy again.
Content-Type:
MessageNewEvent
A new message was sent to a channel the user is watching.
Content-Type:
MessageUpdatedEvent
A message was edited.
Content-Type:
MessageDeletedEvent
A message was removed.
Content-Type:
MessageUndeletedEvent
A previously deleted message was restored.
Content-Type:
MessageReadEvent
A channel was marked as read by a user.
Content-Type:
MessageFlaggedEvent
A message was flagged.
Content-Type:
MessageUnblockedEvent
A previously blocked message was unblocked.
Content-Type:
PendingMessageEvent
A message is pending moderation or a before-message-send hook.
Content-Type:
ReactionNewEvent
A reaction was added to a message.
Content-Type:
ReactionUpdatedEvent
A reaction was modified.
Content-Type:
ReactionDeletedEvent
A reaction was removed from a message.
Content-Type:
ChannelCreatedEvent
A channel was created.
Content-Type:
ChannelUpdatedEvent
A channel was updated.
Content-Type:
ChannelDeletedEvent
A channel was deleted.
Content-Type:
ChannelHiddenEvent
A channel was hidden for a user.
Content-Type:
ChannelVisibleEvent
A previously hidden channel was made visible again.
Content-Type:
ChannelTruncatedEvent
A channel's history was truncated.
Content-Type:
ChannelFrozenEvent
A channel was frozen.
Content-Type:
ChannelUnFrozenEvent
A channel was unfrozen.
Content-Type:
ChannelMutedEvent
A channel was muted by the user.
Content-Type:
ChannelUnmutedEvent
A channel was unmuted by the user.
Content-Type:
MemberAddedEvent
A member was added to a channel.
Content-Type:
MemberRemovedEvent
A member was removed from a channel.
Content-Type:
MemberUpdatedEvent
A member's role or status changed.
Content-Type:
UserPresenceChangedEvent
A user's online/offline presence has changed.
Content-Type:
UserUpdatedEvent
A user's profile was updated.
Content-Type:
UserDeletedEvent
A user was deleted.
Content-Type:
UserBannedEvent
A user was banned.
Content-Type:
UserUnbannedEvent
A user ban was lifted.
Content-Type:
UserMutedEvent
A user was muted.
Content-Type:
UserUnmutedEvent
A user was unmuted.
Content-Type:
UserFlaggedEvent
A user was flagged.
Content-Type:
UserDeactivatedEvent
A user was deactivated.
Content-Type:
UserReactivatedEvent
A user was reactivated.
Content-Type:
UserMessagesDeletedEvent
All messages by a user were deleted.
Content-Type:
UserWatchingStartEvent
A user started watching a channel.
Content-Type:
UserWatchingStopEvent
A user stopped watching a channel.
Content-Type:
UserUnreadReminderEvent
Periodic reminder of unread messages for a user.
Content-Type:
NotificationMessageNewEvent
A new message was sent in a channel the user is a member of but not actively watching.
Content-Type:
NotificationMarkReadEvent
The user's unread counts changed because a channel was marked as read.
Content-Type:
NotificationMarkUnreadEvent
A message was marked unread.
Content-Type:
NotificationAddedToChannelEvent
The user was added to a channel.
Content-Type:
NotificationRemovedFromChannelEvent
The user was removed from a channel.
Content-Type:
NotificationInvitedEvent
The user was invited to a channel.
Content-Type:
NotificationInviteAcceptedEvent
A channel invite was accepted.
Content-Type:
NotificationInviteRejectedEvent
A channel invite was rejected.
Content-Type:
NotificationChannelDeletedEvent
A channel the user is a member of was deleted.
Content-Type:
NotificationChannelTruncatedEvent
A channel the user is a member of was truncated.
Content-Type:
NotificationChannelMutesUpdatedEvent
The user's channel mute list was updated.
Content-Type:
NotificationMutesUpdatedEvent
The user's mute list was updated.
Content-Type:
NotificationThreadMessageNewEvent
A new reply was posted in a thread the user participates in.
Content-Type:
ReminderNotificationEvent
A scheduled reminder is due.
Content-Type:
ReminderCreatedEvent
A reminder was created.
Content-Type:
ReminderUpdatedEvent
A reminder was updated.
Content-Type:
ReminderDeletedEvent
A reminder was deleted.
Content-Type:
ThreadUpdatedEvent
A thread's metadata was updated.
Content-Type:
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.