Beignet API reference
    Preparing search index...

    Interface ScheduleEvent

    Logged when a scheduled task starts, completes, or fails.

    interface ScheduleEvent {
        cron?: string;
        details?: unknown;
        id: string;
        parentSpanId?: string;
        requestId?: string;
        scheduleName: string;
        spanId?: string;
        status: "started" | "completed" | "failed";
        timestamp: string;
        timezone?: string;
        traceId?: string;
        traceparent?: string;
        type: "schedule";
        watcher?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cron? details? id parentSpanId? requestId? scheduleName spanId? status timestamp timezone? traceId? traceparent? type watcher?

    Properties

    cron?: string
    details?: unknown

    Optional structured detail payload. Devtools applies default redaction to this field before events are stored.

    id: string

    Unique identifier for this event (UUID or timestamp-based).

    parentSpanId?: string

    Parent span ID when this event belongs to a nested operation.

    requestId?: string

    Optional correlation ID to link events from the same request/operation.

    scheduleName: string
    spanId?: string

    Span ID for the operation represented by this event.

    status: "started" | "completed" | "failed"
    timestamp: string

    ISO timestamp when the event occurred.

    timezone?: string
    traceId?: string

    W3C trace ID for cross-service correlation.

    traceparent?: string

    W3C traceparent header value associated with this event.

    type: "schedule"
    watcher?: string

    Optional watcher name that owns this event. Built-in events can infer their watcher from type; custom integrations can set this to use their own watcher configuration.

    Settings

    Member Visibility

    On This Page

    Properties