Home

Moztopia Notifications implementation guide

moztopia/notifications provides Laravel-owned notification history, preferences, secure device registrations and independently retried FCM/APNs submissions. It delegates transport to laravel-notification-channels/fcm and laravel-notification-channels/apn.

One logical notification per recipient, one delivery per eligible device, one independent retry lifecycle per delivery.

Available on Packagist as moztopia/notifications. Source tag 0.9.2 “Whisper” is integrated into main through promotion PR #18. It adds category push opt-outs that retain history, server-enforced history-only categories and category-specific Android channels, and includes the 0.9.1 MariaDB index fix. Use Installation for the additive migration and numeric version upgrade. Real-device delivery is still unverified. See the versioned changelog.

Start here

AI agents integrating the package: read Agents Start Here first.

1. Install and migrate.
2. Configure credentials and environments.
3. Register devices and use the public API.
4. Understand the schema and invariants.
5. Run queues, recovery and cleanup.
6. Integrate a Flutter application.
7. Run Pest and real-device smoke tests.
8. Review security and key rotation.

The package exposes no HTTP routes and adds no authentication system. Your application supplies authenticated recipient models, validation, authorization, routes, a database, queue workers and scheduling. No consuming application is modified by this repository.

Supported scope

Laravel 12 and 13, PHP 8.4.27+ and 8.5.12+, UUID recipient models, Android FCM and direct iOS APNs. No Firebase application backend services, browser push, email, SMS or WebSockets. Receipt acknowledgments are deferred.

Provider acceptance means the transport accepted a submission. It does not confirm device receipt, OS display or user interaction. Production Android/iOS delivery remains unverified until the smoke procedure has actually run.

FCM is a no-cost transport; see Google's FCM documentation. Direct APNs has no per-notification subscription fee; Apple Developer Program membership is US$99 per membership year, or local currency where available. Server hosting may also incur costs. See Apple membership.

Documentation maintenance

This wiki is developed in a local clone of the repository’s .wiki.git remote inside the parent checkout’s ignored wiki/ folder. Changes are tracked under the parent repository’s Project and issues, reviewed locally, and pushed to the wiki’s actual default branch; GitHub wikis do not support pull requests. Examples use generic application identities and contain no credentials or information about other products. The package logo is supplied by Moztopia and stored in docs/assets.