AsyncAPI channel · websockets
· WebSocket Communication API
/
The primary WebSocket connection channel. After the opening handshake completes, this channel supports full-duplex message exchange using text or binary data frames.
Channel address
/
Operations
send
sendMessage
Send a message to the WebSocket server
receive
receiveMessage
Receive a message from the WebSocket server
send
sendPing
Send a ping frame
receive
receivePong
Receive a pong frame
send
closeConnection
Initiate connection close
Messages
TextMessage
A UTF-8 encoded text message sent over the WebSocket connection
Content-Type:
text/plainBinaryMessage
A binary message sent over the WebSocket connection
Content-Type:
application/octet-streamPing
A ping control frame used for keep-alive and connection health checks. May include up to 125 bytes of application data.
Content-Type:
Pong
A pong control frame sent in response to a ping. Contains the same application data as the ping it is responding to.
Content-Type:
Close
A close control frame used to initiate the closing handshake. Contains an optional status code and reason string.
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.
Browse every event-driven channel on the APIs.io network or compare with the broader Naftiko capability, Agent Skill, and MCP server surfaces of the same providers.