README

此插件为 Kirby CMS 提供一个面板字段。使用它可以从 Kirby 面板轻松触发 webhooks。
Webhook 的最常见用例可能是触发构建或部署机制。

为什么使用这个

如果您使用 Kirby 运行静态站点，您将想要有一个机制，让编辑人员可以触发新的构建/部署并查看站点的当前状态。这可能是从您的 CMS 内部触发 webhook 的最常见用例。您还可以使用它与 Zapier、IFTTT、电子邮件应用或其他服务进行通信。基本上，每次您想要触发一个通过 webhook 实现的外部服务，并希望在面板中查看结果时，您都可以使用此插件。

您甚至可以使用它来访问任何 API 并按需处理数据，但那时您需要手动处理面板字段的状体。

安装

手动

只需下载此存储库，并将内容放入 /site/plugins/webhook-field。

作为 git 子模块

在 Kirby 安装根目录下运行 git submodule add https://github.com/pju-/kirby-webhook-field site/plugins/webhook-field。

使用 composer

在 Kirby 安装根目录下运行 composer require pju/kirby-webhook-field。

下一步

快速入门指南.

如果您想快速设置部署钩子，请查看快速入门指南。

完整选项指南.

如果您有更复杂的设置或想了解插件提供的可能性，请查看所有选项。

注意事项

名称更改

此插件在测试阶段曾被称为 kirby-webhooks。发布后，我意识到现在有另一个名为 kirby-webhooks 的插件提供了不同的 webhook 集成方法。为了避免混淆并更清晰地显示差异，我将其重命名为 kirby-webhook-field。 如果您已安装旧版本：您将需要将字段类型从 webhooks 重命名为 webhook，并将配置从 pju.webhooks.SETTING 更改为 pju.webhook-field.SETTING，如果更新到新版本。

这个是否可以用于生产环境？

我在几个实际网站上都运行了这个插件。对于您典型的用例，您应该可以毫不犹豫地使用它。我目前知道一些边缘情况，在这些情况下，行为不是理想的。目前，这些问题主要涉及拥有大量页面或多种语言的网站。对于这些网站，"最后修改日期" 的实现不是理想的。您应该禁用这些网站的 "outdated" 选项。如果您想更快地看到那里的进展，可以在此票据上进行评论。

我可以用这个来与 API 通信吗？

当然可以使用它向API发送数据。您可以通过callback选项访问API调用的结果。然而，如果您的API调用没有导致对status端点的后续传入调用，您将不得不自己设置新的状态。如果您现在需要这个功能，请在此工单中告知我，或者创建您自己的。

这是安全的吗？

插件提供的status端点的传入请求只会改变字段的状态。无效的状态将被丢弃。但是，我仍然建议您将端点名称设置为安全的内容。您可以将名称几乎视为API令牌。

pju / kirby-webhook-field

维护者

详细信息