Sanity

Sanity Listen API

Real-time event streaming

GitHub OpenAPI

Operations 1

GET /data/listen/{dataset} Listen for Changes #

Documentation

📖
Documentation
https://www.sanity.io/docs/http-query

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sanity/refs/heads/main/openapi/sanity-listen-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sanity/refs/heads/main/json-schema/sanity-document-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sanity/refs/heads/main/json-schema/sanity-webhook-schema.json

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/sanity/refs/heads/main/graphql/sanity-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sanity-listen-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

GitHub Google LinkedIn

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

OpenAPI Specification

sanity-listen-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sanity HTTP Assets Listen API
  description: The Sanity HTTP API provides access to the Sanity Content Lake platform, enabling querying, mutating, and managing structured content. The API supports GROQ queries, real-time event streaming, asset management, project management, webhooks, scheduling, and AI-powered content agents. Authentication uses Bearer tokens generated from Sanity project settings.
  version: v2024-01-01
  contact:
    name: Sanity Support
    url: https://www.sanity.io/docs
  license:
    name: Commercial
    url: https://www.sanity.io/legal/terms
servers:
- url: https://{projectId}.api.sanity.io/v{apiVersion}
  description: Sanity project-scoped API endpoint
  variables:
    projectId:
      description: Your Sanity project ID
      default: your-project-id
    apiVersion:
      description: API version date (YYYY-MM-DD)
      default: '2024-01-01'
- url: https://api.sanity.io/v{apiVersion}
  description: Sanity management API endpoint
  variables:
    apiVersion:
      description: API version date
      default: '2024-01-01'
security:
- BearerAuth: []
tags:
- name: Listen
  description: Real-time event streaming
paths:
  /data/listen/{dataset}:
    get:
      operationId: listenForChanges
      summary: Listen for Changes
      description: Subscribe to real-time content changes via Server-Sent Events (SSE). The connection stays open and streams events when GROQ-matching documents are created, updated, or deleted.
      tags:
      - Listen
      parameters:
      - name: dataset
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: true
        schema:
          type: string
        description: GROQ query defining which documents to listen to
      - name: includeResult
        in: query
        schema:
          type: boolean
        description: Include full document in change events
      - name: visibility
        in: query
        schema:
          type: string
          enum:
          - query
          - transaction
      responses:
        '200':
          description: SSE stream of change events
          content:
            text/event-stream:
              schema:
                type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Sanity project API token