Notification Consolidated Reference
Summary
A single consolidated reference for day-to-day use. Detailed treatment of each area lives in its own section; this page is the index.
Audience
Engineers, DevOps engineers, QA, support, architects and implementation partners.
Reference Content
The verified reference material for this topic is set out in the sections below.
UI routes
| Route | Screen | Audience |
|---|---|---|
/notifications | Employee inbox, split by audience helper | Employee and other users |
/settings/notification-templates | Legacy template administration | HR administrator |
/operations/notifications | Notification Center operations console | HR administrator |
Plus the header bell widget, present on every page of the client portal.
Operational endpoints
| Endpoint family | Purpose |
|---|---|
| Service root | Service identity, environment and correlation echo |
| Health | HTTP liveness only — no checks registered |
| Statistics | Eight platform-wide counts |
| Failed queue | Messages that exhausted retries |
| Audit | Stage trail filterable by event, correlation or message |
| Message and attempts | Per-message state and per-attempt history |
| Processed-event lookup | Idempotency check for one event |
| Retry | Synchronous re-drive of one message |
| Test dispatch and test publish | Verification hooks with a forced-failure flag |
The full endpoint catalog with methods, validation and responses is in the API section.
Configuration sections
| Section | Covers |
|---|---|
| Notification | Queue name, dead-letter names, prefetch, retry, staleness, seeding, channel overrides, email and placeholder providers |
| RabbitMq | Broker connection settings and the shared exchange name |
| Observability | OTLP endpoint, console exporter flag, and an unread Seq setting |
| Connection strings | One named notification database entry |
| Logging | Default and framework log levels |
One environment variable controls whether migration and seeding run at startup.
Option names, defaults and effects are in configuration. No credential, host or connection value is reproduced anywhere in this documentation.
Log statements
Ten statements: six information, two warning, two error. The two that matter operationally are the consumer's bound-to-queue confirmation and its connect-failure warning. Full catalog in logging reference.
Diagnostics
Audit trail, delivery attempts, idempotency lookup, failed queue, single-message read, statistics and service information. Detail in diagnostics.
Supporting scripts and developer utilities
| Artifact | Purpose |
|---|---|
| Notification smoke script | End-to-end verification in direct or broker mode, with optional gateway exercise |
| Service request collection | A hand-maintained collection of requests against every operational endpoint, using placeholder identifiers |
| Swagger document and UI | Generated from mapped routes; enabled unconditionally, not gated on environment |
| Design-time factory | Allows migration tooling to construct the persistence context outside the host |
| Forced-failure flag | Header and body flag honoured by every channel sender, making failure paths reproducible |
The smoke script accepts a base URL, an optional connection-string override, a mode, and optional gateway parameters. Its prerequisites are a reachable database and, in broker mode, a reachable broker.
Constant sets
Six sets are defined as string constants rather than enums: channels (4), recipient types (4), message statuses (5), delivery statuses (3), processing outcomes (7) and audit stages (13).
Key defaults
| Setting | Default |
|---|---|
| Retry attempts | 3 |
| Retry base delay | 200 ms |
| Backoff factor | 2.0 |
| Prefetch | 5 |
| Staleness window | 168 hours |
| Seed default templates | Enabled |
| Email provider | Console — log only |
| SMS and WhatsApp providers | Placeholder — simulated |
| Header polling interval | 60 seconds |
Section index
Business · Technical · API · Database · Events · UI and Operations (this section).
Classification
Transitional.
Requires confirmation
Production configuration sources and whether Swagger should remain unconditional require confirmation.
Related Articles
See Also
Keywords
- Notification database
- Reference
- Draft database documentation
Source References
microservices/src/notification-service/Api/NotificationEndpoints.csmicroservices/src/notification-service/Program.csmicroservices/src/notification-service/Application/NotificationOptions.csmicroservices/scripts/smoke-notification.ps1microservices/src/notification-service/notification-service.httpUI/salary-ui/apps/client-hrms-portal/src/App.tsxUI/salary-ui/apps/client-hrms-portal/src/components/AppLayout.tsxmicroservices/src/notification-service/Infrastructure/NotificationDbContext.cs
Revision Information
- Status: Draft
- Last reviewed: 2026-07-21
- Review cycle: Quarterly