Documentation

Documentation / @zerotal/notifications / NotificationConfigShape

Interface: NotificationConfigShape

Defined in: notifications/src/types.ts:105

Properties

database

database: object

Defined in: notifications/src/types.ts:106

table

table: string

Table name for stored notifications. Default: 'notifications'

mail

mail: MailConfigShape

Defined in: notifications/src/types.ts:114

Mail-channel settings. Always present (defaults to the log driver), so the mail channel works out of the box without extra configuration.

slack?

optional slack?: object

Defined in: notifications/src/types.ts:120

Slack incoming webhook settings. The per-notification toSlack() method provides the webhookUrl, so this is only needed if you want a global fallback URL.

webhook?

optional webhook?: string

Default webhook URL — can be overridden per-notification in toSlack().

sms?

optional sms?: SmsConfigShape

Defined in: notifications/src/types.ts:128

SMS provider settings (Twilio or Vonage). Required when any notification uses the 'sms' channel.