Shumoul Notification Framework — Developer Guide
The Shumoul Notification Framework delivers notifications across every channel your users expect — Email, SMS, WhatsApp, Push, real-time in-app via SignalR — with built-in delivery tracking, automatic retry, and campaign management, for the Shumoul Cloud ERP platform.
Who it's for: Backend Developers · Angular Developers · Flutter Developers · QA Engineers · Technical Partners · Enterprise Customers
| Field | Value |
|---|---|
| Status | Production Ready |
| Version | Latest |
| Last Updated | 2026-07-04 |
| Maintained By | Shumoul Engineering |
| Documentation | Official Developer Guide |
| Source of Truth | Shumoul Platform Source Code |
Chapters
| # | 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 |
Source of Truth
This guide is written directly against the platform's shipped source code and kept in sync with it. Where a detail could not be independently verified, it is marked (unverified / ambiguous) rather than assumed — see Chapter 20 — Appendix § Verification Notes for the full list and methodology, and Chapter 4 — Architecture Overview for how this framework fits into the wider platform.
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.