Laravel broadcast notifications

To broadcast notifications in Laravel, you can use the `broadcast` channel. First, ensure you have configured and are familiar with Laravel's event broadcasting services[1][2].

To format a broadcast notification, define a `toBroadcast` method on the notification class that returns a `BroadcastMessage` instance with the data to broadcast[1][2]:

php
use Illuminate\Notifications\Messages\BroadcastMessage;

public function toBroadcast($notifiable): BroadcastMessage
{
    return new BroadcastMessage([
        'invoice_id' => $this->invoice->id,
        'amount' => $this->invoice->amount,
    ]);
}

Broadcast notifications are queued by default. To configure the queue connection or name, use the `onConnection` and `onQueue` methods of `BroadcastMessage`[1][2]:

php
return (new BroadcastMessage($data))
    ->onConnection('sqs')
    ->onQueue('broadcasts');

Notifications are broadcast on a private channel formatted as `{notifiable}.{id}`. For example, a notification sent to `App\Models\User` with ID 1 will broadcast on the `App.Models.User.1` channel[2].

To listen for notifications in JavaScript using Laravel Echo, use the `notification` method[2]:

js
Echo.private(`App.Models.User.${userId}`)
    .notification((notification) => {
        console.log(notification.type);
    });

To customize the notification channel, define a `receivesBroadcastNotificationsOn` method on the notifiable entity[2]:

php
public function receivesBroadcastNotificationsOn(): string
{
    return 'users.'.$this->id;
}

By implementing the `ShouldBroadcast` interface and defining a `toBroadcast` method, you can easily broadcast notifications from your Laravel application to real-time clients using Laravel's event broadcasting services.