@archastro/sdk
    Preparing search index...

    Interface Notification

    An inbox notification delivered to a recipient user. Includes type-specific render data resolved at request time.

    interface Notification {
        archived_at?: string;
        created_at: string;
        id: string;
        read_at?: string;
        rendered: Record<string, unknown>;
        status: string;
        type: string;
    }
    Index

    Properties

    archived_at? created_at id read_at? rendered status type

    Properties

    archived_at?: string

    When the recipient archived this notification. null if the notification has not been archived.

    created_at: string

    When the notification was sent (ISO 8601).

    id: string

    Notification ID (ntf_...).

    read_at?: string

    When the recipient marked this notification read. null if the notification has not been read.

    rendered: Record<string, unknown>

    Type-specific render spec resolved at request time. All types include title, kind, and actions; custom types may add their own keys. Notifications whose type is no longer registered render with kind: "unknown".

    status: string

    Current read state of the notification. One of "unread", "read", or "archived".

    type: string

    Notification type slug, e.g. "app_info" for a built-in type or "custom:deploy_complete" for a custom type.

    Settings

    Member Visibility

    On This Page

    Properties