AsyncAPI channel · Amazon API Gateway · Amazon API Gateway WebSocket API Protocol

/{stage}

The WebSocket connection itself. A client opens a single bidirectional WebSocket against this path; API Gateway then routes the lifecycle and each inbound JSON message through the routing model described below. Route selection is configured at the API level by `routeSelectionExpression` (e.g. `${request.body.action}`). API Gateway evaluates the expression against each inbound message and dispatch

Open source AsyncAPI → All Amazon API Gateway channels Amazon API Gateway provider profile
Provider: Amazon API Gateway AsyncAPI: v2.6.0 Spec: Amazon API Gateway WebSocket API Protocol Operations: 2 Messages: 3

Channel address

/{stage}

Parameters

Operations

publish
clientSendMessage
Client sends a message frame to the WebSocket API.
serverPushMessage
Server pushes a message frame to the connected client.

Messages

RouteSelectedMessage
Inbound JSON message where the value extracted by `routeSelectionExpression` matches a customer-configured route key.
Content-Type: application/json
DefaultMessage
Inbound message that did not match any custom route key, or that could not be parsed as JSON for route selection.
Content-Type:
ServerMessage
Outbound frame produced either by an integration response on the matched route or by a backend `PostToConnection` call against the ApiGatewayManagementApi.
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.