basalt / notifications/src / Notifiable

Interface: Notifiable

Defined in: notifications/src/definition.ts:21

Who receives notifications. Apps map their user/tenant models onto this.

Indexable

> [key: string]: unknown

Properties

channelPreferences?

> optional channelPreferences?: Record<string, boolean>

Defined in: notifications/src/definition.ts:27

Per-channel opt-out: { sms: false } silences the sms channel.

---

email?

> optional email?: string

Defined in: notifications/src/definition.ts:23

---

id

> id: string

Defined in: notifications/src/definition.ts:22

---

phone?

> optional phone?: string

Defined in: notifications/src/definition.ts:25

Phone number (E.164, e.g. +244923...) — used by the sms/whatsapp channels.