GraphQL subscription channel that streams route status and route details for
a given route `id`. The client sends a `subscribe` message carrying the
`routeUpdatedById($id: ID!)` operation; the server streams `next` messages
whose payload is a GraphQL result with `status` and (once available) the
`route` object. The client stops listening when `status` is `done`.
Open the route-update subscription for a route id.
subscribe
routeUpdatedById
Receive real-time route status and details for a route id.
Messages
SubscribeRequest
graphql-transport-ws subscribe frame opening the route subscription.
Content-Type: application/json
RouteUpdate
A graphql-transport-ws `next` frame carrying a route execution result.
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.