FastAPI Plugin Notification

A notification plugin for FastAPI that integrates with FastAPI SDK and Postmark provider to send notifications via email and store them in a database.

Features

• 📧 Email Notifications: Send notifications via Postmark email provider
• 💾 Database Storage: Store notifications in MongoDB using ODMantic
• 🔐 User Ownership: Automatic ownership filtering based on user claims
• 📊 Notification Management:
  • Get all notifications for a user
  • Mark notifications as seen/acknowledged
  • Get unseen notification count
• 🗞️ Digests: Daily or weekly digest emails, grouped by category
• 🧹 Retention: Configurable cleanup of notifications past their retention window
• 🚀 FastAPI Integration: Full CRUD API endpoints with authentication
• 📦 PyPI Package: Easy to install and use in any FastAPI project

Installation

Using UV:

uv add fastapi-plugin-notification

Or using pip:

pip install fastapi-plugin-notification

At a Glance

from fastapi_provider_postmark import PostmarkProvider
from fastapi_plugin_notification import NotificationClient

notification_client = NotificationClient(
    postmark_provider=PostmarkProvider(...),
    default_template_id=123456,
)

notification = await notification_client.send_notification(
    db_engine=db,
    name="welcome",
    user_id="user_123",
    user_email="user@example.com",
    claims=request.state.claims,
    link="https://example.com/dashboard",
    link_name="Go to Dashboard",
)

Full setup — client, router and dependencies — is in the Quick Start.

Documentation

Release history is in the Changelog.

License

MIT License - see LICENSE file for details