AsyncAPI channel · Nakama · Nakama Realtime Socket API (WebSocket)

/ws

The single Nakama realtime WebSocket channel. All realtime traffic flows as `Envelope` messages in both directions over this one connection. The `publish` operation below covers envelopes the client sends to the server; the `subscribe` operation covers envelopes the server sends to the client.

Open source AsyncAPI → All Nakama channels Nakama provider profile
Provider: Nakama AsyncAPI: v2.6.0 Spec: Nakama Realtime Socket API (WebSocket) Operations: 2 Messages: 15

Channel address

/ws

Operations

publish
sendEnvelope
Client-to-server realtime messages.
receiveEnvelope
Server-to-client realtime messages.

Messages

ChannelJoin
Client request to join a chat channel (room, direct message, or group).
Content-Type: application/json
ChannelMessageSend
Client request to send a message to a joined channel.
Content-Type: application/json
MatchCreate
Client request to create a new client-relayed multiplayer match.
Content-Type: application/json
MatchJoin
Client request to join a match by id or by matchmaker token.
Content-Type: application/json
MatchDataSend
Client sends an opcode-tagged data frame to all or some match participants.
Content-Type: application/json
MatchmakerAdd
Client request to enter the matchmaking pool with a query and constraints.
Content-Type: application/json
StatusUpdate
Client updates its presence status string.
Content-Type: application/json
Channel
Server reply describing a joined chat channel.
Content-Type: application/json
ChannelMessage
Server-initiated delivery of a message on a joined channel.
Content-Type: application/json
Match
Server reply describing a created or joined match, including presences.
Content-Type: application/json
MatchData
Server-initiated delivery of an opcode-tagged data frame from a match participant.
Content-Type: application/json
MatchmakerMatched
Server-initiated notification that a suitable set of opponents was found.
Content-Type: application/json
StatusPresenceEvent
Server-initiated event describing users who came online or went offline.
Content-Type: application/json
Notifications
Server-initiated delivery of one or more in-app notifications.
Content-Type: application/json
Error
Server error envelope, echoing the cid of the failed request when applicable.
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.

Browse every event-driven channel on the APIs.io network or compare with the broader Agent Skill and MCP server surfaces of the same providers.

Work with this as data

Every channel here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for event channels

4 MCP tools reach this
  • find_channelsBrowse and filter every channel in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This channel 
curl "https://apis.io/api/v1/channels/ws"
All event channels 
curl "https://apis.io/api/v1/channels?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.