How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Amazon API Gateway

Amazon API Gateway WebSocket API

Build real-time two-way communication applications with WebSocket APIs.

Documentation Provider Profile APIs.io AsyncAPI GitHub

Amazon API Gateway WebSocket API is one of 26 APIs that Amazon API Gateway publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Bidirectional, Real-Time, and WebSocket. The published artifact set on APIs.io includes API documentation, a getting-started guide, an AsyncAPI specification, and a JSON-LD context.

This event API exposes 0 operations across 5 channels, and defines 13 schemas. It is described by AsyncAPI 3.0.0, at version 2018-11-29.

The API connects through 2 servers: {api-id}.execute-api.{region}.amazonaws.com (wss), {api-id}.execute-api.{region}.amazonaws.com (https).

0 operations 5 channels 13 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 3.0.0
API Version
2018-11-29
Base URL
https://apigateway.{region}.amazonaws.com
Contact
AWS Support
License
Apache 2.0

Messages & Schemas 13

The contract defines 13 schemas that model the data carried by its messages. The most detailed are RequestIdentity (11 properties), ConnectionRequestContext (6 properties), CustomRoutePayload (3 properties), WebSocketMessage (3 properties). Each schema is shown below with its type and property counts.

ConnectionRequest
message
The initial connection request sent when a client establishes a WebSocket connection. Includes headers, query parameters, and request context from the HTTP upg…
DisconnectionNotice
message
Notification sent when a client disconnects from the WebSocket API, either through a clean close or due to a timeout or error.
DefaultMessage
message
A message received on the $default route when no custom route matches the incoming message content.
CustomRouteMessage
message
A message matched to a custom route based on the route selection expression. The message body is passed to the route's integration.
PostToConnectionMessage
message
A message sent from the backend to a specific connected WebSocket client via the @connections management API.
ConnectionStatusResponse
message
Connection information returned when querying the @connections management endpoint for a specific connection ID.
ConnectionRequestContext
object
The event context provided to the $connect route integration, including request metadata and identity information.
6 properties
DisconnectEventContext
object
The event context provided to the $disconnect route integration when a client disconnects.
1 property
WebSocketMessage
object
A generic WebSocket message received on the $default route. The structure is defined by the application.
3 properties
CustomRoutePayload
object
A message routed to a custom route. Includes an action field (or whatever the route selection expression evaluates) along with application-defined data.
3 properties
BackendMessage
object
A message payload sent from the backend service to a connected WebSocket client via the @connections API.
3 properties
ConnectionInfo
object
Information about a WebSocket connection returned by the @connections management API GET request.
3 properties
RequestIdentity
object
Identity information from the request context.
11 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

amazon-api-gateway-websocket-asyncapi.yml Raw ↑

Other APIs Amazon API Gateway publishes across the network.

Amazon API Gateway Portals
AE Profile APIs.io
Amazon API Gateway ApiKeys API
AE Profile APIs.io
Amazon API Gateway Apis API
AE Profile APIs.io
Amazon API Gateway Authorizers API
AE Profile APIs.io
Amazon API Gateway Connections API
AE Profile APIs.io
Amazon API Gateway Deployments API
AE Profile APIs.io
Amazon API Gateway Integrations API
AE Profile APIs.io
Amazon API Gateway Methods API
AE Profile APIs.io
Amazon API Gateway Resources API
AE Profile APIs.io
Amazon API Gateway RestApis API
AE Profile APIs.io
Amazon API Gateway Routes API
AE Profile APIs.io
Amazon API Gateway Stages API
AE Profile APIs.io
#Bidirectional#Real-Time#WebSocket
← Back to A APIs
API Details
ID
aws-api-gateway:websocket-api
Base URL
https://apigateway.{region}.amazonaws.com
Docs
https://aws.amazon.com/api-gateway/
Provider
Amazon API Gateway
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=websocket-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/websocket-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Amazon API Gateway WebSocket API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.