ccoeder/laravel-notification-webhook

Webhook 通知驱动程序

1.4.0 2019-08-19 19:39 UTC

This package is auto-updated.

Last update: 2024-09-20 06:44:48 UTC


README

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

此包使您能够使用 Laravel 通知系统轻松发送 Webhook。

这是从 miladnouri/laravel-notification-webhook 分支出来的另一个分支,因为我要使用按需通知,所以我添加了对它的支持。

内容

安装

您可以通过 composer 安装此包。

composer require ccoeder/laravel-notification-webhook

用法

现在您可以在通知中的 via() 方法内使用该通道。

use NotificationChannels\Webhook\WebhookMessage;
use Illuminate\Notifications\Notification;

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

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

为了让您的通知知道哪个 URL 应该接收 Webhook 数据,请将 routeNotificationForWebhook 方法添加到您的可通知模型中。

此方法需要返回通知 Webhook 将接收 POST 请求的 URL。

public function routeNotificationForWebhook()
{
    return 'http://myrequest.com/abcd';
}

可用方法

  • data(''): 接受用于 Webhook 体的可 JSON 编码值。
  • userAgent(''): 接受用于 Webhook 用户代理的字符串值。
  • header($name, $value): 设置要发送到 POST Webhook 的附加头信息。

变更日志

有关最近更改的更多信息,请参阅 变更日志

测试

$ composer test

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件