Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowTelemetryEvent<Data>

    A telemetry event descriptor — a structural mirror of @sanity/telemetry's DefinedTelemetryLog, so shells hand these straight to their store logger.

    interface WorkflowTelemetryEvent<Data = void> {
        description?: string;
        maxSampleRate?: number;
        name: string;
        schema: Data;
        type: "log";
        version: number;
    }

    Type Parameters

    • Data = void
    Index

    Properties

    description?: string

    Optional to match the real package's event shape, so an event built with the real defineEvent flows into this seam; the engine's own vocabulary always sets it.

    maxSampleRate?: number

    Advisory volume cap enforced by the shell's store — at most one submission per interval (ms).

    name: string

    Matched verbatim downstream — frozen once shipped.

    schema: Data

    Type-level payload carrier — never set at runtime (the real package's defineEvent leaves it unset the same way).

    type: "log"
    version: number

    Bumped on any payload shape change; the name never changes.