minkbear / webhook
Webhook Notifications driver
Requires
- php: >=5.6.4
- guzzlehttp/guzzle: ~6.0
- illuminate/notifications: 5.3.*|5.4.*|5.5.*|5.6.*
- illuminate/support: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*|5.6.*
Requires (Dev)
- mockery/mockery: ^0.9.5
- orchestra/database: 3.3.x-dev|^3.5.0
- orchestra/testbench: 3.3.x-dev|^3.5.0
- phpunit/phpunit: 4.*|~6.0
README
This package makes it easy to send webhooks using the Laravel 5.3 notification system.
Contents
Installation
You can install the package via composer:
composer require laravel-notification-channels/webhook
Usage
Now you can use the channel in your via()
method inside the notification:
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.
This method needs to return the URL where the notification Webhook will receive a POST request.
public function routeNotificationForWebhook() { return 'http://requestb.in/1234x'; }
Available methods
data('')
: Accepts a JSON-encodable value for the Webhook body.userAgent('')
: Accepts a string value for the Webhook user agent.header($name, $value)
: Sets additional headers to send with the POST Webhook.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Security
If you discover any security related issues, please email m.pociot@gmail.com instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.