Skip to main content

Documentation Index

Fetch the complete documentation index at: https://filamentphp.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

You are currently viewing the documentation for Filament 4.x, which is a previous version of Filament.Looking for the current stable version? Visit the 5.x documentation.

ā€‹
Introduction

By default, Filament will send flash notifications via the Laravel session. However, you may wish that your notifications are ā€œbroadcastā€ to a user in real-time, instead. This could be used to send a temporary success notification from a queued job after it has finished processing. We have a native integration with Laravel Echo. Make sure Echo is installed, as well as a server-side websockets integration like Pusher.

ā€‹
Sending broadcast notifications

There are several ways to send broadcast notifications, depending on which one suits you best. You may use our fluent API: 
use Filament\Notifications\Notification;

$recipient = auth()->user();

Notification::make()
    ->title('Saved successfully')
    ->broadcast($recipient);
Or, use the notify() method: 
use Filament\Notifications\Notification;

$recipient = auth()->user();

$recipient->notify(
    Notification::make()
        ->title('Saved successfully')
        ->toBroadcast(),
)
Alternatively, use a traditional Laravel notification class by returning the notification from the toBroadcast() method: 
use App\Models\User;
use Filament\Notifications\Notification;
use Illuminate\Notifications\Messages\BroadcastMessage;

public function toBroadcast(User $notifiable): BroadcastMessage
{
    return Notification::make()
        ->title('Saved successfully')
        ->getBroadcastMessage();
}

ā€‹
Setting up websockets in a panel

The Panel Builder comes with a level of inbuilt support for real-time broadcast and database notifications. However there are a number of areas you will need to install and configure to wire everything up and get it working.
  1. If you havenā€™t already, read up on broadcasting in the Laravel documentation.
  2. Install and configure broadcasting to use a server-side websockets integration like Pusher.
  3. If you havenā€™t already, you will need to publish the Filament package configuration:
php artisan vendor:publish --tag=filament-config
  1. Edit the configuration at config/filament.php and uncomment the broadcasting.echo section - ensuring the settings are correctly configured according to your broadcasting installation.
  2. Ensure the relevant VITE_* entries exist in your .env file.
  3. Clear relevant caches with php artisan route:clear and php artisan config:clear to ensure your new configuration takes effect.
Your panel should now be connecting to your broadcasting service. For example, if you log into the Pusher debug console you should see an incoming connection each time you load a page.