laravel-notification-channels/webpush

Web Push Notifications driver for Laravel.

Web push notifications channel for Laravel

, _(*1)

This package makes it easy to send web push notifications with Laravel., _(*2)

Installation

You can install the package via composer:, _(*3)

``` bash composer require laravel-notification-channels/webpush, <sub>(*4)</sub>

First add the `NotificationChannels\WebPush\HasPushSubscriptions` trait to your `User` model:

``` php
use NotificationChannels\WebPush\HasPushSubscriptions;

class User extends Model
{
    use HasPushSubscriptions;
}

Next publish the migration with:, <sub>(*5)</sub>

``` bash php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="migrations", <sub>(*6)</sub>

Run the migrate command to create the necessary table:

``` bash
php artisan migrate

You can also publish the config file with:, <sub>(*7)</sub>

``` bash php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="config", <sub>(*8)</sub>

Generate the VAPID keys (required for browser authentication) with:

``` bash
php artisan webpush:vapid

This command will set VAPID_PUBLIC_KEY and VAPID_PRIVATE_KEYin your .env file., <sub>(*9)</sub>

Note: if targeting Safari or iOS after 2023, you will need to include the VAPID_SUBJECT variable as well or Apple will return a BadJwtToken error., <sub>(*10)</sub>

These keys must be safely stored and should not change., <sub>(*11)</sub>

If you still want support for Google Cloud Messaging, set the GCM_KEY and GCM_SENDER_ID in your .env file., <sub>(*12)</sub>

Usage

Now you can use the channel in your via() method inside the notification as well as send a web push notification:, <sub>(*13)</sub>

``` php use Illuminate\Notifications\Notification; use NotificationChannels\WebPush\WebPushMessage; use NotificationChannels\WebPush\WebPushChannel;, <sub>(*14)</sub>

class AccountApproved extends Notification { public function via($notifiable) { return [WebPushChannel::class]; }, <sub>(*15)</sub>

public function toWebPush($notifiable, $notification)
{
    return (new WebPushMessage)
        ->title('Approved!')
        ->icon('/approved-icon.png')
        ->body('Your account was approved!')
        ->action('View account', 'view_account')
        ->options(['TTL' => 1000]);
        // ->data(['id' => $notification->id])
        // ->badge()
        // ->dir()
        // ->image()
        // ->lang()
        // ->renotify()
        // ->requireInteraction()
        // ->tag()
        // ->vibrate()
}

}, <sub>(*16)</sub>

You can find the available options [here](https://github.com/web-push-libs/web-push-php#notifications-and-default-options).

### Save/Update Subscriptions

To save or update a subscription use the `updatePushSubscription($endpoint, $key = null, $token = null, $contentEncoding = null)` method on your user:

``` php
$user = \App\User::find(1);

$user->updatePushSubscription($endpoint, $key, $token, $contentEncoding);

The $key and $token are optional and are used to encrypt your notifications. Only encrypted notifications can have a payload., <sub>(*17)</sub>

Delete Subscriptions

To delete a subscription use the deletePushSubscription($endpoint) method on your user:, <sub>(*18)</sub>

``` php $user = \App\User::find(1);, <sub>(*19)</sub>

$user->deletePushSubscription($endpoint);, <sub>(*20)</sub>

## Browser Compatibility

See the [Push API](https://caniuse.com/#feat=push-api) browser compatibility.

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information about what has changed recently.

## Testing

``` bash
$ composer test

Security

If you discover any security related issues, please email themsaid@gmail.com instead of using the issue tracker., <sub>(*21)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*22)</sub>

Credits

• Cretu Eusebiu
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*23)</sub>