Orchestrator

webhook (Orchestrator)

文本由 Phrase Language AI 从英语机器翻译而得。

webhook 会将事件通知给聊天客户端或其他外部 API 等外部服务。webhook 可以在特定事件发生时设置 URL。

Phrase Orchestrator 提供了一项服务,用于监控和处理来自第三方系统的通知。此服务使用户能够将其工作流与支持 HTTP 请求的各种外部系统连接起来。

传入 webhook

用户可以为来自外部事件的传入 webhook 创建新触发器,系统会自动生成一个带有 API 键的唯一 webhook URL,用于第三方 webhook 设置。生成的 webhook URL 是唯一的,并直接与用户的账户和工作流相关联,这意味着每个 webhook 仅绑定到一个工作流。

配置传入 webhook

要设置 webhook,请按照以下步骤操作:

  1. Webhook 触发器拖放到工作流中。

    Webhook Example

    该触发器会出现在工作流中。

  2. 点击触发打开Overview选项卡。

  3. 选择 Webhook 选项卡。

    1. 复制 Webhook URL

      Webhook URL Location

      此 URL 应被视为机密,不得共享。如果意外共享,请单击Regenerate以创建一个新的并使现有的无效。

    2. 要发送包含可在工作流中使用的数据的有效负载,请提供该有效负载的架构。

      1. 要提供模式,请单击Edit webhook

      2. 选择Input Type

        JSON Schemas 是定义 JSON 有效负载的标准。如果现有服务使用它们,或者要连接到 Orchestrator 的外部服务提供了一个架构,请按原样复制。

        Webhook Input Type
        • JSON

          提供一个示例 JSON 有效负载以进行更简单的设置,从而无需定义确切规则即可测试 webhook。

        • JSON Schema

          精确定义 JSON 数据结构、数据类型和验证规则。

      3. 单击Save payload schema

        显示 webhook 触发器的预期数据结构预览。

    3. 如果需要,打开 Filters 选项卡以向触发器添加过滤器。

要触发已发布的工作流,请向 webhook URL 发送 POST 请求。对于没有配置架构的工作流,主体必须为空。如果应用了配置的架构,则有效负载必须匹配该架构。

传出 webhook

用户可以设置工作流,不仅能接收数据,还能自动向外部系统发送更新。传出 webhook 操作允许用户自动触发外部系统中的特定操作。

其他服务中的 webhook 可以通过“发送 HTTP 请求”操作触发。

配置传出 webhook

要配置传出 webhook,请按照以下步骤操作:

  1. Send HTTP Request 操作拖放到工作流。

  2. 点击该操作以打开配置。

  3. 选择Parameters选项卡并提供所需的设置。

  4. 单击Save parameters

这篇文章有帮助吗?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.