laravel-notifications

laravel-notifications

When to use

Use this skill when sending notifications to users or external systems:

• Email, Slack, SMS, or database notifications
• Custom notification channels
• On-demand notifications (to non-user recipients)
• Notification preferences and opt-out logic

For Mailables (complex email templates, attachments), see laravel-mail.

Procedure: Create a notification

1. Inspect existing notifications — Read app/Notifications/ and the notifiable models for current channels, queue defaults, and per-user preferences.
2. Generate class — php artisan make:notification InvoiceCreated.
3. Choose channels — Mail, database, Slack, or custom. Implement via().
4. Build content — Implement toMail(), toArray(), etc. for each channel.
5. Queue it — Add ShouldQueue interface for non-blocking delivery.
6. Verify — Send test notification, confirm delivery on all channels.

Example

php artisan make:notification InvoiceCreated

class InvoiceCreated extends Notification implements ShouldQueue
{
    use Queueable;

    public function __construct(
        private readonly Invoice $invoice,
    ) {}

    /** @return array<int, string> */
    public function via(object $notifiable): array
    {
        return ['mail', 'database'];
    }

    public function toMail(object $notifiable): MailMessage
    {
        return (new MailMessage())
            ->subject('New Invoice #' . $this->invoice->getNumber())
            ->greeting('Hello ' . $notifiable->getName())
            ->line('A new invoice has been created.')
            ->action('View Invoice', url('/invoices/' . $this->invoice->getId()))
            ->line('Thank you for your business.');
    }

    /** @return array<string, mixed> */
    public function toArray(object $notifiable): array
    {
        return [
            'invoice_id' => $this->invoice->getId(),
            'amount' => $this->invoice->getAmount(),
        ];
    }
}