查看 Application Integration 支持的连接器。

网络钩子触发器

Webhook 触发器是一种连接器事件触发器，可让您根据后端支持 webhook 的任何事件调用集成。Webhook 触发器可从支持 Webhook 事件功能的第三方 SaaS 应用接收事件。此触发器支持事件监听器的多种身份验证类型。

准备工作

如果您计划为 Webhook 触发器创建或配置新连接，请确保您拥有项目的以下 Identity and Access Management (IAM) 角色：

  • Connector Admin (roles/connectors.admin)

    • 如需了解如何授予角色，请参阅管理访问权限。

将以下 IAM 角色授予要用于网络钩子触发器的服务账号：

添加网络钩子触发器

如需向您的集成添加网络钩子触发器，请执行以下步骤：

  1. 在 Google Cloud 控制台中，前往 Application Integration 页面。

    转到 Application Integration

  2. 在导航菜单中，点击集成

    系统随即会显示 Integrations List（集成列表）页面，其中列出了 Google Cloud 项目中可用的所有集成。

  3. 选择现有集成，或点击创建集成以创建新的集成。

    要创建新的集成，请执行以下操作：

    1. 在创建集成窗格中输入名称和说明。
    2. 为集成选择一个区域。
    3. 选择用于集成的服务账号。您可以随时在集成工具栏的 集成摘要窗格中更改或更新集成的服务账号详细信息。
    4. 点击创建。

    这将在集成编辑器中打开集成。

  4. 在集成编辑器导航栏中，点击触发器以查看可用触发器列表。
  5. 点击 Webhook 触发器元素，并将其放入集成编辑器中。

    6. 如需配置网络钩子触发器，您可以使用 Integration Connectors 中提供的现有网络钩子连接，也可以使用内嵌连接创建选项创建新的网络钩子连接。

使用现有连接配置 Webhook 触发器

您可以使用 Integration Connectors 中的现有网络钩子连接来配置网络钩子触发器。请注意，Webhook 触发器是一种连接器事件触发器，因此您只能使用启用了事件订阅的 Webhook 连接来配置触发器。

如需了解如何使用新的 Webhook 连接配置 Webhook 触发器，请参阅使用新连接配置 Webhook 触发器

如需使用现有 Webhook 连接配置网络钩子触发器，请执行以下步骤：

  1. 点击集成编辑器中的网络钩子触发器元素，打开触发器配置窗格。
  2. 点击配置触发器。
  3. 在 Connector Event Trigger Editor 页面中，提供以下配置详细信息：
    1. 区域：选择您的 Webhook 连接所在的区域。
    2. 连接：选择要使用的 Webhook 连接。

      Application Integration 仅显示活跃且已启用事件订阅的 Webhook 连接。

    3. 事件订阅类型：输入您要用于触发集成的事件类型。
    4. 服务账号：为网络钩子触发器选择具有所需 IAM 角色的服务账号。
  4. 点击完成以完成触发器配置并关闭页面。
如需了解详情，请参阅网络钩子连接文档。

使用新连接配置 Webhook 触发器

如需使用新的 Webhook 连接配置 Webhook 触发器，请执行以下步骤：

  1. 点击集成编辑器中的网络钩子触发器元素，打开触发器配置窗格。
  2. 点击配置触发器。
  3. 跳过区域字段。
  4. 点击连接，然后从菜单中选择创建连接选项。
  5. 在创建连接窗格中完成以下步骤：
    1. 在位置部分中，选择连接的位置。
      1. 区域：从列表中选择一个位置。

        连接器支持的区域包括：

        如需查看所有受支持区域的列表，请参阅位置。

      2. 点击下一步。
    2. 在连接详情部分中，完成以下操作：
      1. 连接器：从可用连接器的下拉列表中选择 Webhook。
      2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
      3. 连接名称：输入连接实例的名称。

        连接名称必须符合以下条件：

        • 连接名称可以使用字母、数字或连字符。
        • 字母必须小写。
        • 连接名称必须以字母开头，以字母或数字结尾。
        • 连接名称不能超过 49 个字符。
        • 对于支持事件订阅的连接器，连接名称不能以“goog”开头前缀。
      4. 说明：（可选）输入连接实例的说明。
      5. 服务账号：选择具有所需角色的服务账号。
      6. 事件订阅：事件订阅将默认处于启用状态，对于 Webhook 连接器，事件订阅是强制性的。
      7. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
      8. 点击下一步。
    3. 在 Event Subscription Details 部分中，完成以下操作：
      1. 监听器身份验证：为事件监听器选择身份验证类型，然后输入相关详细信息。

        网络钩子监听器支持以下身份验证类型：

      2. 事件类型字段位置：必填字段，表示与传入事件请求关联的事件类型所在的位置（标头、查询参数或请求正文）。
      3. 事件类型字段名称：所配置位置中的必填字段用于标识 与传入事件请求相关联的事件类型。
        4. {
"event_type": "user.created",
...
// other request fields
...
}
         在上面的示例中，请求正文中的 event_type 字段表示该请求与“user.created”事件相关。
      4. 选择启用专用连接，以便在后端应用与连接之间建立安全连接。如果您选择此选项，则必须执行额外的配置步骤 。如需了解详情，请参阅适用于事件订阅的专用连接。
      5. 输入死信配置。如果您配置了死信，连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息：
        1. 退信项目 ID：您配置退信 Pub/Sub 主题的 Google Cloud 项目 ID。
        2. 死信主题 ：您要在其中写入未处理事件详细信息的 Pub/Sub 主题。
      6. 点击下一步。
    4. 审核：查看您的连接和监听器身份验证详细信息。
    5. 点击创建。

触发器输出

Webhook 触发器需要几分钟才能完成事件订阅配置。您可以在事件订阅详情下的触发器配置窗格中查看事件订阅的状态。

Webhook 触发器使用以下状态指示事件订阅的状态：

  • Creating：表示触发器正在订阅事件订阅。
  • Active：表示触发器已成功订阅事件订阅。
  • Error：表示配置的事件订阅存在问题。

除了事件订阅状态之外，事件订阅详情部分还会显示其他详细信息，例如连接区域、连接名称、事件订阅名称等。

触发器输出变量

对于每个事件，Webhook 触发器会生成一个 ConnectorEventPayload 输出变量，您可以在下游任务中使用该变量。输出变量采用 JSON 格式，包含输出网络钩子载荷架构。

查看事件订阅

要查看和管理与 Integration Connectors 中的连接关联的所有事件订阅，请执行以下操作：

  1. 依次前往 Integration Connectors > Connections 页面。

    转到“连接”页面

  2. 点击您要查看其订阅的连接。
  3. 点击事件订阅标签页。

    此时会显示该连接的所有事件订阅。

修改网络钩子触发器

您可以修改网络钩子触发器，更改或更新关联配置和事件订阅详细信息。

如需修改网络钩子触发器，请执行以下步骤：

  1. 点击集成编辑器中的 Webhook 触发器元素以打开触发器配置窗格。
  2. 点击配置 Webhook 触发器。
  3. 在连接器事件触发器编辑器页面中执行以下操作：
    1. 如需保留之前配置的事件订阅，请点击保留；否则，请点击删除。
    2. 根据需要更新连接配置和事件订阅详细信息。
    3. 点击完成。

    4. 您可以在触发器配置窗格中的事件订阅详情下方查看更新后的连接和事件订阅详情。

配额和限制

如需了解配额和限制，请参阅配额和限制。

后续步骤