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.

Open source AsyncAPI → All Amazon API Gateway channels Amazon API Gateway provider profile
Provider: Amazon API Gateway AsyncAPI: v3.0.0 Spec: Amazon API Gateway WebSocket API Operations: 1 Messages: 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.

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.