AsyncAPI channel · Mattermost
· Mattermost WebSocket API
/api/v4/websocket
The single Mattermost WebSocket channel. The server publishes
event envelopes to the client over this channel, and the client
publishes action envelopes (including the initial
`authentication_challenge`) back to the server.
Receive an event envelope or response from the server.
Messages
AuthenticationChallengeAction
Authenticate the open WebSocket with a token.
Content-Type: application/json
UserTypingAction
Notify the server that the user is typing.
Content-Type: application/json
GetStatusesAction
Request user statuses for users known to the connection.
Content-Type: application/json
GetStatusesByIdsAction
Request user statuses for a specific list of user IDs.
Content-Type: application/json
EventEnvelope
Real-time event broadcast from the Mattermost server.
Content-Type: application/json
ResponseEnvelope
Reply to a client action, correlated via `seq_reply`.
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.