AsyncAPI channel · Covalent
· GoldRush Streaming API
/graphql
Single multiplexed channel. The client and server exchange
`graphql-transport-ws` control frames (`connection_init`, `subscribe`,
`next`, `error`, `complete`, `ping`, `pong`) over this connection. Each
active subscription is identified by a client-generated `id` and carries
one of the supported GoldRush GraphQL subscription operations.
Start a new GraphQL subscription on this connection.
Content-Type: application/json
Complete
Lifecycle frame. Client sends to cancel an active subscription;
server sends when a subscription naturally terminates.
Content-Type: application/json
Ping
Keep-alive ping (either direction).
Content-Type: application/json
Pong
Keep-alive pong (either direction).
Content-Type: application/json
ConnectionAck
Server acknowledgement of a successful connection_init.
Content-Type: application/json
Next
Data frame carrying the payload of an active subscription.
Content-Type: application/json
Error
GraphQL error frame for a specific subscription id.
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.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.