laravel-notification-channels/pushover

Pushover notifications for Laravel.

Pushover notifications channel for Laravel

, _(*1)

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

Contents

• Installation
  • Setting up your Pushover account
• Usage
  • Advanved usage and configuration
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

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

composer require laravel-notification-channels/pushover

Setting up your Pushover account

To start sending messages via Pushover, you have to register an application. Add the generated Pushover application token to the services config file:, _(*4)

// config/services.php
'pushover' => [
    'token' => 'YOUR_APPLICATION_TOKEN',
],

Usage

Now you can use the channel in your via() method inside the notification as well as send a push notification:, _(*5)

use NotificationChannels\Pushover\PushoverChannel;
use NotificationChannels\Pushover\PushoverMessage;
use Illuminate\Notifications\Notification;

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

    public function toPushover($notifiable)
    {
        return PushoverMessage::create('The invoice has been paid.')
            ->title('Invoice paid')
            ->sound('incoming')
            ->lowPriority()
            ->url('http://example.com/invoices', 'Go to your invoices');
    }
}

To send Pushover notifications to the notifiable entity, add the routeNotificationForPushover method to that model. Usually, this is the User model. The pushover_key could be a database field and editable by the user itself., _(*6)

public function routeNotificationForPushover()
{
    return $this->pushover_key;
}

Advanced usage and configuration

If you want to specify specific devices, you can return a PushoverReceiver object., _(*7)

public function routeNotificationForPushover() {
    return PushoverReceiver::withUserKey('pushover-key')
        ->toDevice('iphone')
        ->toDevice('desktop')
        // or, if you prefer:
        ->toDevice(['iphone', 'desktop']);
}

If you want to (dynamically) overrule the application token from the services config, e.g. because each user holds their own application token, return a PushoverReceiver object like this:, _(*8)

public function routeNotificationForPushover() {
    return PushoverReceiver::withUserKey('pushover-key')
        ->withApplicationToken('app-token');
}

You can also send a message to a Pushover group:, _(*9)

public function routeNotificationForPushover() {
    return PushoverReceiver::withGroupKey('pushover-group-key');
}

Available Message methods

Changelog

Please see CHANGELOG for more information what has changed recently., _(*10)

Testing

bash $ composer test, _(*11)

Security

If you discover any security related issues, please email mail@casperboone.nl instead of using the issue tracker., _(*12)

Contributing

Please see CONTRIBUTING for details., _(*13)

Credits

• Casper Boone
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*14)