Webhooks 会通知外部服务,比如聊天客户端或其他外部 API,告知相关事件。Webhook 可以在特定事件发生时设置一个 URL。
Phrase Orchestrator 提供了一项服务,用于监控和处理来自第三方系统的通知。此服务使用户能够将其工作流与支持 HTTP 请求的各种外部系统连接。
用户可以为来自外部事件的传入 webhook 创建一个新的触发器,系统会自动生成一个唯一的 webhook URL,并为第三方 webhook 设置提供 API 秘钥。生成的 webhook URL 是唯一的,并且直接与用户的账户和工作流相关联,这意味着每个 webhook 仅与一个工作流相关联。
配置传入 webhook
要配置传入 webhook,请按照以下步骤操作:
-
将 触发器拖放到工作流中。
触发器出现在工作流中。
-
点击触发打开选项卡。
-
选择 选项卡。
-
复制 。
此 URL 应被视为秘密,不应共享。如果意外共享,请单击Regenerate以创建一个新的并使现有的无效。
-
要发送包含数据的有效负载以在工作流中使用,请提供该有效负载的架构。
-
要提供模式,请单击Edit webhook。
-
选择:
JSON 架构 是定义 JSON 有效负载的标准。如果有现有服务正在使用它们,或者有外部服务用于连接 Orchestrator 并提供了一个,请直接复制即可。
-
JSON
提供一个示例 JSON 有效负载以简化设置,允许在不定义确切规则的情况下测试 webhook。
-
JSON Schema
精确定义 JSON 数据的结构、数据类型和验证规则。
-
-
单击Save payload schema。
webhook 触发器的预期数据结构预览已显示。
-
-
如有需要,打开 选项卡,为触发器添加筛选条件。
-
要在工作流发布后触发它,请向 webhook URL 发送 POST 请求。对于未配置架构的工作流,请确保请求体为空。如果应用了配置的架构,则有效负载必须与架构匹配。