Laravel Notification Log

The notification_log_items table includes a JSON column named extra for storing custom metadata.

To populate this column, implement a logExtra method within your Notification class. This method must accept an Illuminate\Notifications\Events\NotificationSending event as its argument and return an array of data. This array will be automatically stored in the extra column when the notification is logged.

use Illuminate\Notifications\Events\NotificationSending;

// in a notification
public function logExtra(NotificationSending $event): array
{
    return ['extraKey' => 'extraValue'];
}

You can use a custom model instead of the default NotificationLogItem to customize behaviors such as the database connection or pruning strategies.

To implement this:

1. Create a new class that extends Spatie\NotificationLog\Models\NotificationLogItem.
2. Update your notification-log configuration file to point to your new class using the model key.

// 1. Create your custom model
use Spatie\NotificationLog\Models\NotificationLogItem;

class CustomLogItem extends NotificationLogItem
{
    // Add custom properties or methods here
}

// 2. Register it in config/notification-log.php
return [
    'model' => CustomLogItem::class,
    // ...
];

By default, the package saves the fully qualified class name of a notification into the notification_type column of the notification_log_items table.

To use a custom string instead of the class name, implement a logType() method within your notification class. This method must return a string representing the value you want to be stored in the database.

// in a notification

public function logType(): string
{
    return 'customType';
}

By default, notifications are logged based on their constructor parameters. To provide a custom, human-readable, or specific identifier for a notification in the logs, add a fingerprint() method to your notification class. This method should return a string. This string will be stored in the fingerprint column of the NotificationLogItem model.

use Illuminate\Notifications\Notification;

class OrderSentNotification extends Notification
{
    public function __construct(
        public Order $order,
    ) {}
    
    public function fingerprint()
    {
        return "order-\{$this->order->id}";
    }
}

By including the Spatie\NotificationLog\Models\Concerns\HasHistory trait in your Notification class, you gain access to methods that allow you to inspect the notification's history. This is useful for implementing rate-limiting or conditional sending logic within the shouldSend() method.

For example, you can use wasSentTo($notifiable)->inThePastMinutes(60) to ensure a notification is only sent if it hasn't been sent to that specific user in the last 60 minutes.

use Spatie\NotificationLog\Models\Concerns\HasHistory;

// in a notification
class MyNotification extends Notification
{
    use HasHistory;

    // verifying if the queued notification can be sent based in the history
    public function shouldSend($notifiable)
    {
          return ! $this
            ->wasSentTo($notifiable)
            ->inThePastMinutes(60);
    }
}

Install the package using Composer to add it to your Laravel project.

composer require spatie/laravel-notification-log

After installing the package, publish the migrations and run them to create the notification_log_items table.

php artisan vendor:publish --tag="notification-log-migrations"
php artisan migrate

Before installing laravel-notification-log, ensure your environment meets the following minimum requirements:

• PHP: 8.2 or higher
• Laravel: 10 or higher
• Database: MySQL 8.0 or higher (required because the package utilizes json columns)

When using Laravel's On Demand Notifications feature (sending notifications to addresses not backed by a specific model), the laravel-notification-log package handles them by setting both notifiable_id and notifiable_type to null in the notification_log_items table.

To configure how these anonymous notifications are handled, use the anonymous_notifiable_properties property in your configuration.

Notification::route('mail', 'taylor@example.com')
    ->notify(new InvoicePaidNotification($invoice));