Sanity Library Reference Docs
    Preparing search index...

    Interface BlueprintDocumentWebhookResourceBeta

    A webhook resource definition This feature is subject to breaking changes.

    interface BlueprintDocumentWebhookResource {
        apiVersion: string;
        dataset: string;
        description?: string | null;
        displayName?: string;
        filter?: string;
        headers?: Record<string, string>;
        httpMethod?: "POST" | "PUT" | "PATCH" | "DELETE" | "GET";
        includeAllVersions?: boolean;
        includeDrafts?: boolean;
        name: string;
        on: WebhookTrigger[];
        project?: string;
        projection?: string;
        secret?: string;
        status?: "enabled" | "disabled";
        type: "sanity.project.webhook";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiVersion dataset description? displayName? filter? headers? httpMethod? includeAllVersions? includeDrafts? name on project? projection? secret? status? type url

    Properties

    apiVersion: string

    Must start with 'v' and use the format YYYY-MM-DD

    dataset: string
    description?: string | null
    displayName?: string

    Display name shown in the Sanity dashboard

    The name of the resource

    filter?: string
    headers?: Record<string, string>
    httpMethod?: "POST" | "PUT" | "PATCH" | "DELETE" | "GET"
    includeAllVersions?: boolean
    includeDrafts?: boolean
    name: string

    The name of the resource. Unique within the blueprint. e.g. 'sync-webhook'

    on: WebhookTrigger[]
    project?: string
    projection?: string
    secret?: string
    status?: "enabled" | "disabled"
    type: "sanity.project.webhook"

    The type of the resource. e.g. 'sanity.project.webhook'

    url: string

    Settings

    Member Visibility

    On This Page

    Properties