如何在Laravel中轻松发送自定义Webhook通知？使用laravel-notification-channels/webhook助你高效集成

<code class="bash">composer require laravel-notification-channels/webhook</code>

<pre class="brush:php;toolbar:false;">// app/Notifications/ProjectCreated.php
<?php

namespace App\Notifications;

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

class ProjectCreated extends Notification
{
    protected $projectData;

    public function __construct(array $projectData)
    {
        $this->projectData = $projectData;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [WebhookChannel::class]; // 声明通过 WebhookChannel 发送
    }

    /**
     * Get the webhook representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \NotificationChannels\Webhook\WebhookMessage
     */
    public function toWebhook($notifiable)
    {
        return WebhookMessage::create()
            ->data([ // 设置 Webhook 的请求体数据
               'event' => 'project_created',
               'payload' => $this->projectData
            ])
            ->userAgent("My-Laravel-App/1.0") // 可选：设置自定义 User-Agent
            ->header('X-Custom-Auth', 'your-secret-token'); // 可选：添加自定义请求头
    }
}

<pre class="brush:php;toolbar:false;">// app/Models/User.php (或者你的其他 Notifiable 模型)
<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * Route notifications for the webhook channel.
     *
     * @param  \Illuminate\Notifications\Notification  $notification
     * @return string
     */
    public function routeNotificationForWebhook($notification)
    {
        // 这里返回 Webhook 接收的 URL
        // 这个 URL 可以是动态的，例如从数据库中读取
        return 'http://your-third-party-service.com/webhook-endpoint';
        // 也可以根据通知类型返回不同的URL
        // if ($notification instanceof ProjectCreated) {
        //     return 'http://another-service.com/project-webhooks';
        // }
        // return 'http://default-webhook-url.com';
    }
}

<pre class="brush:php;toolbar:false;">use App\Models\User;
use App\Notifications\ProjectCreated;

// 假设我们有一个用户实例，并且项目数据已准备好
$user = User::find(1);
$projectData = [
    'id' => 123,
    'name' => 'My Awesome Project',
    'status' => 'created'
];

// 发送 Webhook 通知
$user->notify(new ProjectCreated($projectData));

<pre class="brush:php;toolbar:false;">use Illuminate\Contracts\Queue\ShouldQueue;

class ProjectCreated extends Notification implements ShouldQueue
{
    // ...
}