core-utils
    Preparing search index...

    Interface TriggerRequest

    Request parameters for triggering a notification.

    interface TriggerRequest {
        attempt: number;
        body: TriggerBody;
        dryRun?: boolean;
        expiresAt: Date;
        idempotencyKey: TriggerIdempotencyKey;
        keysToRedact?: string[];
        workflowKey: string;
    }
    Index

    Properties

    attempt body dryRun? expiresAt idempotencyKey keysToRedact? workflowKey

    Properties

    attempt: number

    Attempt number for tracing.

    body

    body: TriggerBody

    Trigger payload.

    dryRun?: boolean

    If true, the notification will not be sent, but the request will be validated and logged. Helpful when controlling notifications with feature flags.

    false
    expiresAt: Date

    expiresAt prevents stale notifications across retries by dropping the request when now > expiresAt. If, for example, you're notifying about an event that starts in one hour, you might set this to one hour from now.

    If you're triggering from a background job, don't set this at the call site, set it when you enqueue the job. Otherwise, it gets updated each time the job retries, will always be in the future, and won't prevent stale notifications.

    idempotencyKey: TriggerIdempotencyKey

    TriggerIdempotencyKey

    keysToRedact?: string[]

    Array of data keys to redact in logs for privacy.

    []
    workflowKey: string

    Workflow key.

    Settings

    Member Visibility

    On This Page

    Properties