# Mattermost WebSocket API

**Canonical:** https://apis.io/apis/mattermost/websocket-api/  
**Provider:** Mattermost — https://apis.io/providers/mattermost/  
**Base URL:** wss://your-mattermost-server.com/api/v4/websocket  
**Documentation:** https://developers.mattermost.com/api-documentation

Mattermost WebSocket API is one of 6 APIs that [Mattermost](https://apis.io/providers/mattermost/) publishes on the [APIs.io](https://apis.io/) network, described by an AsyncAPI event-driven specification. Tagged areas include WebSocket, Event, Real-Time, Messaging, and AsyncAPI. The published artifact set on APIs.io includes API documentation, an AsyncAPI specification, and an API reference.

Real-time WebSocket event stream for Mattermost v4. Clients connect to /api/v4/websocket, authenticate via cookie, Authorization header, or an authentication_challenge action, and receive event envelopes (event, data, broadcast, seq) covering posts, channels, users, teams, reactions, typing, status, threads, plugins, and more. Client actions user_typing, get_statuses, and get_statuses_by_ids are supported over the same socket.

## Machine-readable artifacts (3)

- **Documentation** — https://developers.mattermost.com/api-documentation
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/mattermost/refs/heads/main/asyncapi/mattermost-asyncapi.yml
- **APIReference** — https://developers.mattermost.com/integrate/reference/rest-api/

## Other Mattermost APIs (5)

- [Mattermost REST API](https://apis.io/apis/mattermost/rest-api/)
- [Mattermost Channels API](https://apis.io/apis/mattermost/mattermost-channels-api/)
- [Mattermost Posts API](https://apis.io/apis/mattermost/mattermost-posts-api/)
- [Mattermost Teams API](https://apis.io/apis/mattermost/mattermost-teams-api/)
- [Mattermost Users API](https://apis.io/apis/mattermost/mattermost-users-api/)

## Tags

WebSocket, Event, Real-Time, Messaging, AsyncAPI

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/mattermost/websocket-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/mattermost/.