Beignet API reference
    Preparing search index...

    Interface NotificationChannelResult

    Result for one notification channel.

    interface NotificationChannelResult {
        channel: string;
        details?: Record<string, unknown>;
        id?: string;
        provider?: string;
        reason?: string;
        status: "failed" | "sent" | "skipped";
    }
    Index

    Properties

    channel details? id? provider? reason? status

    Properties

    channel: string

    Channel name, such as email, sms, push, or inApp.

    details?: Record<string, unknown>

    Channel-specific metadata. Dispatchers should keep this safe to log.

    id?: string

    Provider delivery ID when available.

    provider?: string

    Provider name when available.

    reason?: string

    Human-readable skip or failure reason.

    status: "failed" | "sent" | "skipped"

    Delivery outcome for this channel.

    Settings

    Member Visibility

    On This Page

    Properties