lukonet/laravel-hooks-notification-channel

Hooks Notifications Driver

Hooks Notifications Channel for Laravel 5.3

, _(*1)

UPDATE: It seems like the Hooks service is no longer active, hence, this project has been archived., _(*2)

This package makes it easy to send notifications using Hooks with Laravel 5.3., _(*3)

Hooks API lets you send a notification to all users subscribed to your custom alert., _(*4)

Contents

• Installation
  • Setting up the Hooks service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

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

``` bash composer require lukonet/laravel-hooks-notification-channel, <sub>(*6)</sub>

You must install the service provider:

```php
// config/app.php
'providers' => [
    ...
    NotificationChannels\Hooks\HooksServiceProvider::class,
],

Setting up the Hooks service

1. Sign up for a developer account on Hooks site.
2. Get the API Key, located in the account page.
3. Create a custom alert on alerts page.
4. Obtain the alert id associated with your notification, located in your alerts page. It'll be used when sending a notification.

Then, configure your Hooks API Key by adding it to the config/services.php file:, <sub>(*7)</sub>

// config/services.php
...
'hooks' => [
    'key' => env('HOOKS_API_KEY', 'YOUR HOOKS API KEY HERE')
],
...

Usage

You can now use the channel in your via() method inside the Notification class., <sub>(*8)</sub>

``` php use NotificationChannels\Hooks\HooksChannel; use NotificationChannels\Hooks\HooksMessage; use Illuminate\Notifications\Notification;, <sub>(*9)</sub>

class NewsUpdate extends Notification { public function via($notifiable) { return [HooksChannel::class]; }, <sub>(*10)</sub>

public function toHooks($notifiable)
{
    $url = url('/news/' . $notifiable->id);

    return HooksMessage::create()
        ->alertId('<Hooks Alert ID>') // Optional.
        ->message('Laravel 5.3 launches with the all new notifications feature!')
        ->url($url);
}

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

Here's a screenshot preview of the above notification on Hooks App:

![Laravel Hooks Notification Example](https://cloud.githubusercontent.com/assets/1915268/17791360/63550c58-65b8-11e6-84d3-cc5db57a0f80.jpg)

### Routing a message

You can either send the notification by providing with the alert id to the `alertId($alertId)` method like shown in the above example or add a `routeNotificationForHooks()` method in your notifiable model:

``` php
...
/**
 * Route notifications for the Hooks channel.
 *
 * @return int
 */
public function routeNotificationForHooks()
{
    return 'YOUR ALERT ID HERE';
}
...

Available Message methods

• alertId($alertId): (integer) The alert id associated with your notification, located in your alerts page.
• message(''): (string) The message of the notification.
• url($url): (string) The related url of this notification.

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*12)</sub>

Testing

bash $ composer test, <sub>(*13)</sub>

Security

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

Contributing

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

Credits

• Syed Irfaq R.
• All Contributors

License

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