AsyncAPI channel · Amazon API Gateway
· Amazon API Gateway WebSocket API
$connect
The $connect route is invoked when a client first connects to the WebSocket API. This is where authentication and authorization occur. The connection is established only if the integration returns a successful response. Query string parameters and headers from the initial HTTP upgrade request are available to the integration.
Provider:Amazon API GatewayAsyncAPI: v3.0.0Spec: Amazon API Gateway WebSocket APIOperations: 1Messages: 1
Channel address
$connect
Operations
receive
onConnect
Receives the initial WebSocket connection request from a client. The $connect route integration can validate credentials, register the connection ID, and decide whether to accept the connection.
Messages
ConnectionRequest
The initial connection request sent when a client establishes a WebSocket connection. Includes headers, query parameters, and request context from the HTTP upgrade request.
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.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.