Laravel FCM Notification Channel

When an FCM notification fails, Laravel dispatches the Illuminate\Notifications\Events\NotificationFailed event. You can listen for this event to perform cleanup tasks, such as deleting expired or invalid FCM tokens from your database.

namespace App\
Listeners;

use Illuminate\Notifications\Events\NotificationFailed;
use Illuminate\Support\Arr;

class DeleteExpiredNotificationTokens
{
    public function handle(NotificationFailed $event): void
    {
        if ($event->channel == \NotificationChannels\Fcm\FcmChannel::class) {
            $report = Arr::get($event->data, 'report');
            $target = $report->target();

            $event->notifiable->notificationTokens()
                ->where('push_token', $target->value())
                ->delete();
        }
    }
}

Register the listener in your EventServiceProvider:

protected $listen = [
    \Illuminate\Notifications\Events\NotificationFailed::class => [
        \App\Listeners\DeleteExpiredNotificationTokens::class,
    ],
];

To send notifications to specific users, implement the toFcm method in your Notification class and return an FcmMessage. You must also define a routeNotificationForFcm() method on your Notifiable model to provide the device token(s).

use Illuminate
otifications\
Notification;
use NotificationChannels\Fcm\FcmChannel;
use NotificationChannels\Fcm\FcmMessage;
use NotificationChannels\Fcm\Resources\Notification as FcmNotification;

class AccountActivated extends Notification
{
    public function via($notifiable)
    {
        return [FcmChannel::class];
    }

    public function toFcm($notifiable): FcmMessage
    {
        return (new FcmMessage(notification: new FcmNotification(
                title: 'Account Activated',
                body: 'Your account has been activated.',
                image: 'http://example.com/url-to-image-here.png'
            )))
            ->data(['data1' => 'value', 'data2' => 'value2'])
            ->custom([
                'android' => [
                    'notification' => [
                        'color' => '#0A0A0A',
                        'sound' => 'default',
                    ],
                    'fcm_options' => [
                        'analytics_label' => 'analytics',
                    ],
                ],
                'apns' => [
                    'payload' => [
                        'aps' => [
                            'sound' => 'default'
                        ],
                    ],
                    'fcm_options' => [
                        'analytics_label' => 'analytics',
                    ],
                ],
            ]);
    }
}

// In your User model:
class User extends Authenticatable
{
    use Notifiable;

    public function routeNotificationForFcm()
    {
        return $this->fcm_token; // Or return an array of tokens for multicast
    }
}

// To trigger:
$user->notify(new AccountActivated);

The FcmTopicChannel is a specialized channel used to send Firebase Cloud Messaging notifications to entire topics rather than individual device tokens.

To use this channel, your notification class must implement a toFcm method that returns an FCM message object. The channel determines the target topic using one of two methods:

1. From the Message object: If the message returned by toFcm($notifiable) has a topic explicitly set, that topic is used.
2. From the Notifiable: If the message does not have a topic set, the channel attempts to resolve the topic via the $notifiable->routeNotificationFor('fcm-topic') method.

If no topic is found in either location, the notification is not sent.

<?php

namespace App\Notifications;

use NotificationChannels\Fcm\FcmMessage;
use Illuminate
otifications\Notification;

class TopicNotification extends Notification
{
    public function toFcm($notifiable): FcmMessage
    {
        return FcmMessage::create()
            ->setTopic('news')
            ->setData(['key' => 'value']);
    }
}