Webhook 触发器

通过单一 URL 监听用户事件

Webhook 触发器的工作方式通常如下:

启用时: 使用 context.webhookUrl 发起 HTTP 请求,在第三方应用中注册 Webhook,并将 Webhook ID 存储在 store 中。

握手: 某些服务需要成功的握手请求,通常包含某种质询。其工作方式类似于普通的 run,只是你需要返回正确的质询响应。这是可选的,为了启用握手,你需要在 handshakeConfiguration 选项中配置可用的握手策略。

运行时: 你可以在 context.payload.body 中找到 HTTP 请求体。如果需要,可以修改请求体;否则,返回一个包含 context.payload.body 单个项目的数组。

禁用时: 使用 context.store 从启用步骤中获取 Webhook ID,并在第三方应用中删除该 Webhook。

测试: 你无法使用测试工作流功能测试它,因为它使用 Piece 中提供的静态示例数据。 要测试触发器,请发布工作流,执行事件,然后从主仪表板检查工作流运行情况。

示例:

要使你的 Webhook 可从互联网访问,你需要将本地开发实例暴露到互联网,请执行以下操作:
  1. 安装 localxpose
  2. 按照文档启动第一个指向 localhost:4200 的隧道。
  3. 复制隧道域名,例如 wozcsvaint.loclx.io,并将 .env.dev 中的 AP_FRONTEND_URL 环境变量替换为暴露的 URL,例如 https://wozcsvaint.loclx.io
  4. 前往 /packages/web/vite.config.ts,取消注释 allowedHosts 并将值替换为相同的隧道域名,例如 wozcsvaint.loclx.io。

完成这些配置后,你将能够测试 Webhook 触发器和运行包含它们的已发布工作流。