hello-one/laravel-webhooks

解析来自hello-one.de的webhook请求

0.1.1 2020-05-17 02:28 UTC

This package is auto-updated.

Last update: 2024-09-18 10:13:46 UTC


README

安全地接收来自您的hello one项目的webhook。

安装

  1. 您可以使用以下命令通过composer安装此包

    composer require hello-one/laravel-webhooks

    该包将自动使用包发现注册自身。

  2. 在您的仪表板上将您的应用添加为webhook。默认路由是

    https://{{yourdomain.com}}/hello-one/webhook
    

    请注意:我们只支持TLS端点(只支持https)

  3. 复制密钥签名密钥

  4. 将密钥签名密钥添加到您的.env文件中

    HELLO_ONE_WEBHOOK_SIGNING_SECRET={{INSERT_TOKEN_HERE}
  5. 您的应用现在将接收来自您的hello one项目的活动。您可以通过从我们的仪表板发送测试事件来测试集成

用法

此包处理来自hello one的传入webhook请求。它验证hello one webhook请求的请求签名。当请求有效时,包会发出Laravel事件

要响应任何事件,您可以创建事件监听器。

使用通配符监听所有webhook事件

Event::listen('hello-one.webhook.*', function (string $eventName, array $data) {
    Log::info('hello one event received: '.  $eventName, $data);
});

监听特定事件

Event::listen('hello-one.webhook.guest.created', function (string $eventName, array $data) {
    Log::info('A new Guest was just created', $data['guest']['id']);
    // use the data from $data['guest'] 
});

事件列表

您可以从我们的API查询完整的事件列表

curl -X GET "https://api.hello-one.de/api/webhooks/events" -H  "accept: application/json"

请注意:在Laravel中,所有事件都以hello-one.webhook.为前缀

配置

发布配置文件并根据需要进行调整

 php artisan vendor:publish --tags 'hello-one-webhooks'

文档

请参阅我们的Webhook文档

贡献

请随时提交工单、提交拉取请求或联系我们的支持团队