Member Junction
    Preparing search index...

    Interface SendNotificationParams

    Parameters for sending a notification through the unified notification system

    interface SendNotificationParams {
        allowedDeliveryChannels?: Partial<DeliveryChannels>;
        forceDeliveryChannels?: DeliveryChannels;
        message: string;
        resourceConfiguration?: any;
        resourceRecordId?: string;
        resourceTypeId?: string;
        templateData?: Record<string, any>;
        title: string;
        typeNameOrId: string;
        userId: string;
    }
    Index

    Properties

    allowedDeliveryChannels? forceDeliveryChannels? message resourceConfiguration? resourceRecordId? resourceTypeId? templateData? title typeNameOrId userId

    Properties

    allowedDeliveryChannels?: Partial<DeliveryChannels>

    A ceiling on delivery, applied last — after preferences, type defaults, and forceDeliveryChannels. Only an explicit false restricts a channel; true and undefined leave it to normal resolution.

    This exists for callers that carry their own per-record channel toggles — a Scheduled Job's NotifyViaEmail/NotifyViaInApp, a User Routine's equivalents — where two different people have a say: the person who configured the job chose which channels it may use, and the recipient chose which channels they want. Composing them is an intersection, and neither existing knob expresses it. forceDeliveryChannels would let the job override the recipient's opt-out, and omitting the toggles entirely would let a channel the job never asked for fire off a type default.

    Because it can only subtract, a caller cannot use this to escalate past a preference — which is the property that makes it safe to expose.

    forceDeliveryChannels?: DeliveryChannels

    Force specific delivery channels, overriding user preferences and type defaults. When specified, these channels are used instead of resolving from preferences.

    message: string

    Full notification message (used for in-app display)

    resourceConfiguration?: any

    Optional navigation context stored as JSON (conversation ID, artifact details, etc.)

    resourceRecordId?: string

    Optional resource record ID for linking notification to a specific record

    resourceTypeId?: string

    Optional resource type ID for linking notification to a specific resource

    templateData?: Record<string, any>

    Data object for template rendering (email/SMS templates)

    title: string

    Short notification title (used for in-app and email subject)

    typeNameOrId: string

    Notification type name (e.g., 'Agent Completion') or UUID

    userId: string

    User ID to send notification to

    Settings

    Member Visibility

    On This Page

    Properties