biegalski-llc/notification-tracker

Notification Tracker is a Laravel package that empowers developers to seamlessly track and manage the lifecycle of user notifications. Gain valuable insights into notification status (sent, delivered, read), content, and recipient interactions.

dev-main 2024-09-09 22:30 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^10.0||^11.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• spatie/laravel-ray: ^1.35

MIT

• Michael Biegalski

• laravel
• BiegalskiLLC
• notification-tracker

README

Notification Tracker is a Laravel package that empowers developers to seamlessly track and manage the lifecycle of user notifications. Gain valuable insights into notification status (sent, delivered, read), content, recipient interactions and more.

This package is meant to be a sensible replacement for the Mailgun Webhooks For Laravel package. It is designed to be more flexible, easier to use and less opinionated. The goal is to also target many notification services, rather than a single service.

Every project has different needs. At its core, Notification Tracker acts as a simple vehicle for ingesting notification data sent by third-party service webhooks. It then triggers a Laravel event, allowing you to listen in and do whatever you need with the notification data. This includes storing the content, updating the status, forwarding the email or SMS, and much more.

The flexibility of this approach gives you complete control over how you handle and process your notification data within your Laravel application.

Installation

You can install the package via composer:

composer require biegalski-llc/notification-tracker

Configuration

Mailgun

In order to track Mailgun notifications, you will need to add the following to your config/services.php file.

'mailgun' => [
    'webhook_signing_key' => env('MAILGUN_WEBHOOKS_SIGNING_KEY', null)
],

Additionally, you'll need to utilize the following middleware for your Mailgun webhook route.

BiegalskiLLC\NotificationTracker\Providers\Email\Mailgun\Middleware\ValidateMailgunWebhookMiddleware::class

Usage

$notificationTracker = new BiegalskiLLC\NotificationTracker();

Mailgun

$notificationTracker->mailgun()
    ->payload( $request->all() )
    ->status('delivered') //change to specific webhook status
    ->run();

Postmark

$notificationTracker->postmark()
    ->payload( $request->all() )
    ->status('delivered') //change to specific webhook status
    ->run();

Custom Handler

Pass your own custom handler in. Reference existing handlers for examples.

use App\Handlers\CustomHandler;

$notificationTracker->email()
    ->handler( CustomHandler::class )
    ->payload( $request->all() )
    ->status('delivered') //change to specific webhook status
    ->run();

Events/Listeners

When the notification tracker is run, it will trigger an event containing the notification content and details. You can listen for this event and do whatever you need with the notification data.

Store the notification content, update the delivery status, forward an email or SMS, or anything else you can think of.

NotificationTrackerEmailEvent

namespace App\Listeners;

use BiegalskiLLC\NotificationTracker\Events\NotificationTrackerEmailEvent;

class NotificationTrackerEmailListener
{
    public function handle(NotificationTrackerEmailEvent $event)
    {
        //do something with the notification data
    }
}

NotificationTrackerSmsEvent

namespace App\Listeners;

use BiegalskiLLC\NotificationTracker\Events\NotificationTrackerSmsEvent;

class NotificationTrackerSmsListener
{
    public function handle(NotificationTrackerSmsEvent $event)
    {
        //do something with the notification data
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Michael Biegalski
• paulredmond - Laravel Middleware to Validate a signed Mailgun Webhook.

License

The MIT License (MIT). Please see License File for more information.