The realtime WebSocket channel. After the client opens the connection
(authenticating with a Beam Bearer token), it may publish input messages
and subscribe to output messages streamed back from the deployed handler.
Send an input payload to the deployed realtime handler.
subscribe
receiveRealtimeOutput
Receive output payloads streamed from the realtime handler.
Messages
RealtimeInput
A JSON payload sent from the client into the deployed handler.
Content-Type: application/json
RealtimeOutput
A JSON payload streamed from the handler back to the client.
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.