Server-Sent Events stream of mutations to documents matching the subscribed
GROQ query. Verified live: an anonymous GET with `Accept: text/event-stream`
returns HTTP 200 and immediately emits a `welcome` event, then holds the
connection open.
query — GROQ query (query string parameter, URL-encoded) selecting the documents to
subscribe to. `*` subscribes to every document in the dataset.
Operations
receive
receiveContentEvents
Receive content mutation events for the PSC marketing site.
Messages
welcome
Emitted once, immediately after the stream opens.
Content-Type: application/json
mutation
Emitted when a document matching the subscribed query is created, updated or
deleted. Not observed during the probe window; fields below follow Sanity's
public documentation for this endpoint.
Content-Type: application/json
channelError
Emitted when the subscription fails (for example an invalid GROQ query).
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.