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

$disconnect

The $disconnect route is invoked after a client disconnects from the WebSocket API. This route is best-effort and may not be invoked in all cases (e.g., network interruptions). Use this route for cleanup operations such as removing connection records from a database.

Provider: Amazon API Gateway AsyncAPI: v3.0.0 Spec: Amazon API Gateway WebSocket API Operations: 1 Messages: 1

Channel address

$disconnect

Operations

receive
onDisconnect
Receives notification when a client disconnects. Use this to perform cleanup such as removing the connection ID from storage.

Messages

DisconnectionNotice
Notification sent when a client disconnects from the WebSocket API, either through a clean close or due to a timeout or error.
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.