laravel-notification-channels/webhook

Webhook Notifications driver

Webhook notifications channel for Laravel

, _(*1)

This package makes it easy to send webhooks using the Laravel notification system., _(*2)

Compatibility

Contents

• Installation
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

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

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

## Usage

Now you can use the channel in your `via()` method inside the notification:

``` php
use NotificationChannels\Webhook\WebhookChannel;
use NotificationChannels\Webhook\WebhookMessage;
use Illuminate\Notifications\Notification;

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

    public function toWebhook($notifiable)
    {
        return WebhookMessage::create()
            ->data([
               'payload' => [
                   'webhook' => 'data'
               ]
            ])
            ->userAgent("Custom-User-Agent")
            ->header('X-Custom', 'Custom-Header');
    }
}

In order to let your Notification know which URL should receive the Webhook data, add the routeNotificationForWebhook method to your Notifiable model., <sub>(*5)</sub>

This method needs to return the URL where the notification Webhook will receive a POST request., <sub>(*6)</sub>

public function routeNotificationForWebhook()
{
    return 'http://requestb.in/1234x';
}

Available methods

• data(''): Accepts a JSON-encodable value for the Webhook body.
• query(''): Accepts an associative array of query string values to add to the request.
• userAgent(''): Accepts a string value for the Webhook user agent.
• header($name, $value): Sets additional headers to send with the POST Webhook.
• verify(): Enable the SSL certificate verification or provide the path to a CA bundle

Changelog

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

Testing

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

Security

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

Contributing

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

Credits

• Marcel Pociot
• All Contributors

License

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