Sanity · Schema

Sanity Webhook

Schema for a Sanity webhook configuration for receiving event-driven content notifications.

Headless CMSContent ManagementGROQReal-TimeStructured ContentDeveloper Platform

Properties

Name Type Description
id string Unique webhook identifier (assigned by Sanity)
name string Human-readable webhook name
url string Target URL to receive webhook POST requests
dataset string Dataset to watch for changes
filter string GROQ filter expression to match specific documents
projection string GROQ projection to shape the webhook payload
on array Events that trigger the webhook
secret string Optional secret for signing webhook payloads (HMAC-SHA256)
isDisabled boolean Whether the webhook is currently disabled
createdAt string
View JSON Schema on GitHub

JSON Schema

sanity-webhook-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/sanity/json-schema/webhook.json",
  "title": "Sanity Webhook",
  "description": "Schema for a Sanity webhook configuration for receiving event-driven content notifications.",
  "type": "object",
  "required": ["name", "url", "dataset", "on"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique webhook identifier (assigned by Sanity)"
    },
    "name": {
      "type": "string",
      "description": "Human-readable webhook name"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Target URL to receive webhook POST requests"
    },
    "dataset": {
      "type": "string",
      "description": "Dataset to watch for changes",
      "examples": ["production", "staging"]
    },
    "filter": {
      "type": "string",
      "description": "GROQ filter expression to match specific documents",
      "examples": ["_type == 'post'", "_type in ['post', 'page']"]
    },
    "projection": {
      "type": "string",
      "description": "GROQ projection to shape the webhook payload"
    },
    "on": {
      "type": "array",
      "description": "Events that trigger the webhook",
      "minItems": 1,
      "items": {
        "type": "string",
        "enum": ["create", "update", "delete"]
      }
    },
    "secret": {
      "type": "string",
      "description": "Optional secret for signing webhook payloads (HMAC-SHA256)"
    },
    "isDisabled": {
      "type": "boolean",
      "description": "Whether the webhook is currently disabled",
      "default": false
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/sanity-webhook"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

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