PHPackages                             nkamuo/notification-tracker-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. nkamuo/notification-tracker-bundle

ActiveSymfony-bundle[Mail & Notifications](/categories/mail)

nkamuo/notification-tracker-bundle
==================================

\[EXPERIMENTAL\] Notification and email tracking bundle for Symfony with webhook support - DO NOT USE IN PRODUCTION

v0.11.1(7mo ago)041MITPHPPHP >=8.2CI failing

Since Sep 19Pushed 7mo agoCompare

[ Source](https://github.com/nkamuo/notification-tracker-bundle)[ Packagist](https://packagist.org/packages/nkamuo/notification-tracker-bundle)[ RSS](/packages/nkamuo-notification-tracker-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (26)Versions (61)Used By (0)

📧 Notification Tracker Bundle
=============================

[](#-notification-tracker-bundle)

> **⚠️ EXPERIMENTAL** - This project is in active development and should not be used in production environments. APIs and features may change without notice.

**Automatically track and analyze** all emails and notifications sent through Symfony Mailer and Notifier components.

🎯 What This Bundle Does
-----------------------

[](#-what-this-bundle-does)

This bundle **automatically captures and tracks** notifications sent through:

- ✅ **Symfony Mailer** - All emails sent via `$mailer->send()`
- ✅ **Symfony Notifier** - All notifications sent via `$notifier->send()`
- ✅ **Manual API** - Custom notifications via REST API

**No code changes required!** Just install, configure, and start tracking.

🚀 Quick Start
-------------

[](#-quick-start)

1. **Install**: `composer require nkamuo/notification-tracker-bundle`
2. **Configure**: Add to `bundles.php`
3. **Migrate**: Run `doctrine:migrations:migrate`
4. **Use**: Send emails/notifications as normal - they're automatically tracked!

📚 Documentation
---------------

[](#-documentation)

**👉 START HERE: [Complete Documentation](docs/MAIN_DOCUMENTATION.md)**

### Essential Links

[](#essential-links)

- 📖 **[Main Guide](docs/MAIN_DOCUMENTATION.md)** - Complete setup and usage
- 🌐 **[API Reference](docs/API_REFERENCE.md)** - REST API documentation
- 🔍 **[Custom Filters](docs/API_FILTERS.md)** - Advanced API filtering
- ⚠️ **[Experimental Notice](EXPERIMENTAL.md)** - Important warnings

🧪 Experimental Status
---------------------

[](#-experimental-status)

**This is an experimental project** - use at your own risk:

- ✅ Core tracking functionality works
- ⚠️ APIs may change without notice
- 🚧 Active development in progress
- 🔬 Suitable for testing and evaluation only

🎯 Key Features
--------------

[](#-key-features)

- 📧 **Multi-channel Support**: Email, SMS, Slack, Telegram, Push notifications
- 🔄 **Native Symfony Integration**: Works seamlessly with Symfony Mailer and Notifier events
- 📊 **Complete Tracking**: Track sent, delivered, opened, clicked, bounced, and failed messages
- 🔗 **Webhook Support**: Integrate with SendGrid, Twilio, Mailgun, and more
- 🚀 **Async Processing**: Built-in Symfony Messenger support
- 🔍 **API Platform Integration**: Rich REST API for browsing and managing notifications
- 📈 **Real-time Analytics**: Performance metrics and engagement statistics
- ⚙️ **Highly Configurable**: Environment-based configuration with sensible defaults

💻 Installation
--------------

[](#-installation)

```
composer require nkamuo/notification-tracker-bundle
```

### Register the Bundle

[](#register-the-bundle)

If not using Symfony Flex, register the bundle in `config/bundles.php`:

```
return [
    // ...
    Nkamuo\NotificationTrackerBundle\NotificationTrackerBundle::class => ['all' => true],
];
```

### Run Migrations

[](#run-migrations)

```
php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate
```

⚙️ Basic Configuration
----------------------

[](#️-basic-configuration)

Create `config/packages/notification_tracker.yaml`:

```
notification_tracker:
    enabled: true
    tracking:
        enabled: true
        track_opens: true
        track_clicks: true
```

📊 Usage Examples
----------------

[](#-usage-examples)

### Automatic Tracking

[](#automatic-tracking)

The bundle automatically tracks all emails and notifications sent through Symfony's components:

```
// Emails are automatically tracked
$email = (new Email())
    ->from('hello@example.com')
    ->to('you@example.com')
    ->subject('Time for Symfony Mailer!')
    ->html('See Twig integration for better HTML integration!');

$mailer->send($email);
```

### API Access

[](#api-access)

Browse and manage notifications via API Platform:

```
# List tracked messages
GET /api/notification-tracker/messages

# Get message details
GET /api/notification-tracker/messages/{id}

# Retry failed message
POST /api/notification-tracker/messages/{id}/retry

# View analytics
GET /api/notification-tracker/analytics
```

### Console Commands

[](#console-commands)

```
# Process failed messages
php bin/console notification-tracker:process-failed

# View analytics
php bin/console notification-tracker:analytics

# Clean up old messages
php bin/console notification-tracker:cleanup --days=90
```

🔗 Webhook Setup
---------------

[](#-webhook-setup)

Configure your webhook endpoints with your providers:

- **SendGrid**: `https://your-domain.com/webhooks/notification-tracker/sendgrid`
- **Twilio**: `https://your-domain.com/webhooks/notification-tracker/twilio`
- **Mailgun**: `https://your-domain.com/webhooks/notification-tracker/mailgun`

🧪 Testing
---------

[](#-testing)

```
composer test
composer cs-fix
composer phpstan
```

🤝 Support
---------

[](#-support)

For issues and feature requests, please use the [GitHub issue tracker](https://github.com/nkamuo/notification-tracker-bundle/issues).

📄 License
---------

[](#-license)

MIT

---

**Ready to enhance your notification system with comprehensive tracking and analytics?** 🚀

Check out the [complete documentation](docs/MAIN_DOCUMENTATION.md) to get started!

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance62

Regular maintenance activity

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

56

Last Release

238d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/329bb1f962f7202967c211be87549ce038a95cde9d1ca11d93cfb0874986034d?d=identicon)[nkamuo](/maintainers/nkamuo)

---

Top Contributors

[![nkamuo](https://avatars.githubusercontent.com/u/47611586?v=4)](https://github.com/nkamuo "nkamuo (118 commits)")

---

Tags

symfonybundleemailnotificationnotifiertrackingmailerwebhook

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/nkamuo-notification-tracker-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/nkamuo-notification-tracker-bundle/health.svg)](https://phpackages.com/packages/nkamuo-notification-tracker-bundle)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k16.7M310](/packages/easycorp-easyadmin-bundle)[chameleon-system/chameleon-base

The Chameleon System core.

1026.5k3](/packages/chameleon-system-chameleon-base)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)