Webhook

借助网络钩子连接器,您可以监听来自后端的事件。此连接器可与网络钩子触发器搭配使用。如需在集成中使用网络钩子触发器,您必须先配置网络钩子连接器。

准备工作

在使用网络钩子连接器之前,请执行以下任务:

  • 在您的 Google Cloud 项目中:
    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务,请参阅启用服务

    • 向要用于连接器的服务帐号授予以下 IAM 角色:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务帐号

    如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。

配置连接器

配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:

  1. Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 位置部分中,选择连接的位置。
    1. 区域:从下拉列表中选择一个位置。

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

    2. 点击下一步
  4. Connection Details 部分中,完成以下操作:
    1. 连接器:从可用连接器下拉列表中选择网络钩子
    2. 连接器版本:从可用版本的下拉列表中选择连接器版本。
    3. 连接名称:输入连接实例的名称。

      连接名称必须满足以下条件:

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. 说明:(可选)输入连接实例的说明。
    5. 服务账号:选择具有所需角色的服务账号。
    6. 事件订阅:事件订阅将默认启用,对于网络钩子连接器来说是强制性的。
    7. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    8. 点击下一步
  5. 事件订阅详情部分,完成以下操作:
    1. 监听器身份验证:为事件监听器选择身份验证类型,然后输入相关详细信息。

      webhook 监听器支持以下身份验证类型:

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

在集成中使用网络钩子连接

创建连接后,它在 Apigee Integration 和 Application Integration 中均可使用。您可以通过连接器任务在集成中使用该连接。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务
  • 如需了解如何在 Application Integration 中创建和使用连接器任务,请参阅连接器任务

向 Google Cloud 社区寻求帮助

您可以在 Cloud 论坛的 Google Cloud 社区发布您的问题并讨论此连接器。

后续步骤