Beignet API reference
    Preparing search index...

    Interface RequestEvent

    Logged when the server handles a request mapped from a contract.

    interface RequestEvent {
        contractName?: string;
        details?: unknown;
        durationMs?: number;
        id: string;
        method: string;
        parentSpanId?: string;
        path: string;
        requestId?: string;
        spanId?: string;
        status?: number;
        summary?: string;
        timestamp: string;
        traceId?: string;
        traceparent?: string;
        type: "request";
        watcher?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    contractName? details? durationMs? id method parentSpanId? path requestId? spanId? status? summary? timestamp traceId? traceparent? type watcher?

    Properties

    contractName?: string
    details?: unknown

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

    durationMs?: number
    id: string

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

    method: string
    parentSpanId?: string

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

    path: string
    requestId?: string

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

    spanId?: string

    Span ID for the operation represented by this event.

    status?: number
    summary?: string
    timestamp: string

    ISO timestamp when the event occurred.

    traceId?: string

    W3C trace ID for cross-service correlation.

    traceparent?: string

    W3C traceparent header value associated with this event.

    type: "request"
    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