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 Gateway AsyncAPI: v2.6.0 Spec: Amazon API Gateway WebSocket API Protocol Operations: 1 Messages: 1

Channel address

$connect

Operations

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.

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.