Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravel-notification-channels/webpush
Webpush notifications channel for Laravel.
https://github.com/laravel-notification-channels/webpush
laravel notifications webpush
Last synced: 2 days ago
JSON representation
Webpush notifications channel for Laravel.
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/webpush
- Owner: laravel-notification-channels
- License: mit
- Created: 2016-08-12T09:41:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T12:43:38.000Z (5 months ago)
- Last Synced: 2024-12-15T04:00:10.202Z (9 days ago)
- Topics: laravel, notifications, webpush
- Language: PHP
- Homepage: http://laravel-notification-channels.com
- Size: 142 KB
- Stars: 689
- Watchers: 25
- Forks: 120
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Web push notifications channel for Laravel
[](https://packagist.org/packages/laravel-notification-channels/webpush)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/webpush)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/webpush/?branch=master)
[](https://packagist.org/packages/laravel-notification-channels/webpush)
This package makes it easy to send web push notifications with Laravel.
## Installation
You can install the package via composer:
``` bash
composer require laravel-notification-channels/webpush
```
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:
``` bash
php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="migrations"
```
Run the migrate command to create the necessary table:
``` bash
php artisan migrate
```
You can also publish the config file with:
``` bash
php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="config"
```
Generate the VAPID keys (required for browser authentication) with:
``` bash
php artisan webpush:vapid
```
This command will set `VAPID_PUBLIC_KEY` and `VAPID_PRIVATE_KEY`in your `.env` file.
> 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.
__These keys must be safely stored and should not change.__
If you still want support for [Google Cloud Messaging](https://console.cloud.google.com), set the `GCM_KEY` and `GCM_SENDER_ID` in your `.env` file.
## Usage
Now you can use the channel in your `via()` method inside the notification as well as send a web push notification:
``` php
use Illuminate\Notifications\Notification;
use NotificationChannels\WebPush\WebPushMessage;
use NotificationChannels\WebPush\WebPushChannel;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [WebPushChannel::class];
}
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()
}
}
```
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.
### Delete Subscriptions
To delete a subscription use the `deletePushSubscription($endpoint)` method on your user:
``` php
$user = \App\User::find(1);
$user->deletePushSubscription($endpoint);
```
## 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 [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Cretu Eusebiu](https://github.com/cretueusebiu)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.