AsyncAPI channel · Amazon API Gateway
· Amazon API Gateway WebSocket API Protocol
$connect
Platform-reserved route invoked exactly once when API Gateway accepts a new
WebSocket connection. The integration receives no message body; instead it
receives the connection's `requestContext`, query string, headers, and any
identity claims. A non-2xx response from this route's integration causes
API Gateway to reject the connection (used for AuthN/Z gating).
Provider:Amazon API GatewayAsyncAPI: v2.6.0Spec: Amazon API Gateway WebSocket API ProtocolOperations: 1Messages: 1
Channel address
$connect
Operations
subscribe
onConnect
API Gateway delivers a `$connect` lifecycle event to the integration.
Messages
ConnectEvent
$connect lifecycle event
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.
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.