Skip to content

js-bao-wss-client


js-bao-wss-client / SendNotificationParams

Interface: SendNotificationParams ​

Parameters for notifications.send() (requires app admin permission): the notification content, the target user, the delivery channels, and optional expiry, tracing, and idempotency controls.

Properties ​

body ​

body: string


channels? ​

optional channels?: string[]

Channel list; defaults to ["in-app"].


optional deepLink?: string


expiresAt? ​

optional expiresAt?: string

ISO date string; the inbox row expires (and is auto-deleted) after this.


iconUrl? ​

optional iconUrl?: string


idempotencyKey? ​

optional idempotencyKey?: string

Dedupe key: a repeat send with the same key returns the prior outcome.


sourceRef? ​

optional sourceRef?: string

Recorded on the row for tracing; defaults to api:<caller>.


target ​

target: object

userId ​

userId: string


title ​

title: string

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30