Notification Service API

Auto-generated from NestJS controller decorators. Last synced: 2026-03-15

Base path: /api
Endpoints: 17

Health

Liveness probe

GET/health

Readiness probe

GET/ready

Notifications

Send notification (service-to-service only)

POST/notifications/sendBearer token

Request Body: CreateNotificationDto

tenantIdstringRequired

—

userIdstringRequired

—

typeNotificationTypeRequired

—

eventTypestringRequired

—

subjectstringRequired

—

bodystringRequired

—

metadataRecordstring, unknown

—

emailTostring

—

List notifications for current user (paginated)

GET/notificationsBearer token

pagenumber

query parameter

limitnumber

query parameter

Get unread notification count

GET/notifications/unreadBearer token

Mark a notification as read

PATCH/notifications/:id/readBearer token

idstringRequired

path parameter

Mark all notifications as read

PATCH/notifications/read-allBearer token

Delete a notification

DELETE/notifications/:idBearer token

idstringRequired

path parameter

Preferences

List notification preferences for current user

GET/notifications/preferencesBearer token

Update notification preference for an event type

PUT/notifications/preferences/:eventTypeBearer token

eventTypestringRequired

path parameter

Request Body: UpdatePreferenceInput

emailEnabledboolean

—

inAppEnabledboolean

—

Templates

List all email templates

GET/templatesBearer token

categorystring

query parameter

activestring

query parameter

Get branding for current tenant

GET/templates/branding/currentBearer token

Update branding for current tenant

PUT/templates/branding/currentBearer token

Request Body: UpdateBrandingDto

logoUrlstring

—

primaryColorstring

—

secondaryColorstring

—

footerTextstring

—

replyToAddressstring

—

companyNamestring

—

Get a specific email template

GET/templates/:idBearer token

idstringRequired

path parameter

Update an email template

PUT/templates/:idBearer token

idstringRequired

path parameter

Render a Handlebars template preview

POST/templates/previewBearer token

Send a test email for a template

POST/templates/:id/send-testBearer token

idstringRequired

path parameter

Request Body: SendTestEmailDto

toEmailstringRequired

—

variablesRecordstring, unknown

—