Sanity Library Reference Docs
    Preparing search index...

    Interface PublishDocumentVersionEventBeta

    interface PublishDocumentVersionEvent {
        author: string;
        contributors?: string[];
        creationEvent?: CreateDocumentVersionEvent;
        documentId: string;
        documentVariantType: DocumentVariantType;
        id: string;
        publishCause: "document.publish" | "release.publish" | "release.schedule";
        release?: ReleaseDocument | { _id: string; metadata?: undefined };
        releaseId?: string;
        revisionId: string;
        timestamp: string;
        type: "publishDocumentVersion";
        versionId: string;
        versionRevisionId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    author contributors? creationEvent? documentId documentVariantType id publishCause release? releaseId? revisionId timestamp type versionId versionRevisionId?

    Properties

    author: string
    contributors?: string[]
    creationEvent?: CreateDocumentVersionEvent

    This is added client side to enhance the UI. For draft documents, it indicates the event that created this document that was later published It will be used to expand the publish view.

    documentId: string
    documentVariantType: DocumentVariantType

    This is added client side to enhance the UI.

    id: string
    publishCause: "document.publish" | "release.publish" | "release.schedule"
    release?: ReleaseDocument | { _id: string; metadata?: undefined }

    This is added client side to enhance the UI.

    releaseId?: string
    revisionId: string
    timestamp: string
    type: "publishDocumentVersion"
    versionId: string
    versionRevisionId?: string

    This is only available when it was triggered by Publish action.

    Settings

    Member Visibility

    On This Page

    Properties