Shumoul Notification Framework — Official Developer Guide
Version: 1.0.0 · Status: Living document, generated from source as of 2026-07-04 · Classification: {{brand.classification.internal}}
This is the complete official documentation for the Shumoul Notification Framework — the multi-channel notification, delivery, retry, and campaign engine used across the Shumoul Cloud ERP platform.
It is written for: Backend Developers, Angular Developers, Flutter Developers, QA Engineers, Technical Partners, Enterprise Customers, and Future Internal Developers.
Every fact in this documentation was verified directly against the source code of the following repositories as of the date above. Where a claim could not be verified, it is explicitly marked (unverified / ambiguous) rather than invented — see 20-appendix.md § Verification Notes.
Shumoul.Saas.Api(E:\SaaS\Shumoul.BackEnd\Shumoul) — ERP host, controllers, ERP-specific entitiesShumoul.Saas.NotificationFramework(E:\SaaS\Shumoul.Saas.NotificationFramework) — Contracts, Abstractions, Core, Persistence, SignalR packagesShumoul.Saas.MultiTenancyApi(E:\SaaS\Shumoul.MultiTenancyApi) — legacy SignalR hub and legacy notification controllersShumoul.Saas.WhatsAppIntegration— WhatsApp Cloud API client library
Branding
This documentation uses centralized semantic branding tokens, not hardcoded assets. See
docs/assets/branding/ — official Shumoul logo, colors, and typography are
applied in a separate branding pass once the official Brand Guideline is added there. See CLAUDE.md §20.
Table of Contents
| # | Section | File |
|---|---|---|
| 1 | Cover | 01-cover.md |
| 2 | Table of Contents | 02-table-of-contents.md |
| 3 | Introduction | 03-introduction.md |
| 4 | Architecture Overview | 04-architecture-overview.md |
| 5 | Framework Packages | 05-framework-packages.md |
| 6 | Runtime Flow | 06-runtime-flow.md |
| 7 | Notification Channels | 07-notification-channels.md |
| 8 | Notification Templates | 08-notification-templates.md |
| 9 | API Documentation | 09-api-reference/README.md |
| 10 | SignalR | 10-signalr.md |
| 11 | Device Tokens | 11-device-tokens.md |
| 12 | Retry Engine & Dead Letter Queue | 12-retry-engine.md |
| 13 | Notification History | 13-notification-history.md |
| 14 | Permissions | 14-permissions.md |
| 15 | Configuration | 15-configuration.md |
| 16 | Deployment | 16-deployment.md |
| 17 | Testing Guide | 17-testing-guide.md |
| 18 | Troubleshooting | 18-troubleshooting.md |
| 19 | FAQ | 19-faq.md |
| 20 | Appendix | 20-appendix.md |
Export targets
Every file in this folder is plain Markdown with no proprietary formatting, so the set can be exported to PDF, static HTML, GitHub Pages, Docusaurus, Docsify, or BookStack without rewriting content — only a branding/theme pass and a build-tool configuration are needed.