> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Sanity webhooks

> Sanity incoming webhooks in Corsair: the event paths to subscribe to, the payload each event carries, and the response data.

The Sanity plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see [Overview](https://docs.corsair.dev/plugins/sanity/overview.md) for setup context and the exact URL shape).

> [!NOTE]
>
> **New to Corsair?** See [webhooks](https://docs.corsair.dev/concepts/webhooks.md) and [hooks](https://docs.corsair.dev/concepts/hooks.md).

## Webhook map

* `documents`
  * `changed` (`documents.changed`)

## HTTP handler setup

```ts app/api/webhook/route.ts theme={null}
import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    // With multiTenancy, give each tenant its own URL (/api/webhook?tenantId=acme):
    // the query says whose account, secret and hooks handle the delivery.
    const query = Object.fromEntries(new URL(request.url).searchParams);
    // The raw text, not request.json(): signatures are checked over the exact bytes sent.
    const body = await request.text();
    const result = await processWebhook(corsair, headers, body, query);
    if (!result.plugin) {
        return Response.json({ success: false }, { status: 404 });
    }
    // A refusal (bad signature) carries no status and answers 400; a handler
    // that threw comes back with 500, so the sender retries it.
    const status =
        result.response?.success === false ? (result.response.statusCode ?? 400) : 200;
    return Response.json(result.response ?? { success: true }, {
        status,
        headers: result.responseHeaders,
    });
}
```

## Events

## Documents

### Changed

`documents.changed`

A GROQ-powered webhook fired: a document matching its filter was created, updated or deleted. The body is the webhook's projection; the operation, document id and dataset come from its headers. Only signed deliveries are accepted.

**Payload:** `any`

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   operation?: create | update | delete | string | null,
>   documentId?: string | null,
>   projectId?: string | null,
>   dataset?: string | null,
>   webhookId?: string | null,
>   transactionId?: string | null,
>   transactionTime?: string | null,
>   idempotencyKey?: string | null,
>   body: any
> }
> ```

**`webhookHooks` example**

```ts theme={null}
sanity({
    webhookHooks: {
        documents: {
            changed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.