Setu-TS
    Preparing search index...

    Interface NotificationMessage

    A notification dispatched across one or more channels.

    0.1.0

    interface NotificationMessage {
        body: string;
        channels: readonly string[];
        metadata?: Readonly<Record<string, unknown>>;
        subject?: string;
        to: Readonly<Record<string, string>>;
    }
    Index
    body channels metadata? subject? to

    Readonlybody

    body: string

    Notification body.

    channels: readonly string[]

    Channel names to dispatch on (e.g. ['email', 'sms']).

    metadata?: Readonly<Record<string, unknown>>

    Channel-specific extras.

    The four built-in channels (email, sms, push, slack) accept these but do not read them; they exist for custom channel implementations registered alongside the built-ins.

    subject?: string

    Subject/title, for channels that support one.

    to: Readonly<Record<string, string>>

    Recipient addresses keyed by channel (e.g. { email: '…', phone: '…' }).

    Settings
    Member Visibility

    On This Page
    Properties