网络钩子
借助 Webhook 连接器,您可以监听支持 Webhook 的后端中的事件。此连接器专门用于与网络钩子触发器搭配使用。Webhook 触发器会接收来自支持 Webhook 事件功能的第三方 SaaS 应用的事件。此触发器支持为事件监听器使用多种身份验证类型。如需在集成中使用 Webhook 触发器,您必须先配置 Webhook 连接器。
准备工作
在使用 Webhook 连接器之前,请先完成以下任务:
- 在您的 Google Cloud 项目中:
- 启用以下服务:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
如需了解如何启用服务,请参阅启用服务。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号。
如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。
- 启用以下服务:
配置连接器
配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:
- 在 Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中,选择连接的位置。
- 区域:从下拉列表中选择一个位置。
如需查看所有受支持区域的列表,请参阅位置。
- 点击下一步。
- 区域:从下拉列表中选择一个位置。
- 在连接详情部分中,完成以下操作:
- 连接器:从可用连接器的下拉列表中选择 Webhook。
- 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
- 连接名称:输入连接实例的名称。
连接名称必须符合以下条件:
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头,以字母或数字结尾。
- 连接名称不能超过 49 个字符。
- 对于支持事件订阅的连接器,连接名称不得以“goog”前缀开头。
- 说明:(可选)输入连接实例的说明。
- 服务账号:选择具有所需角色的服务账号。
- 事件订阅:事件订阅将默认处于启用状态,对于 Webhook 连接器,事件订阅是强制性的。
- (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
- 点击下一步。
-
在事件订阅详情部分中,完成以下操作:
- 监听器身份验证:为事件监听器选择身份验证类型,然后输入相关详细信息。
Webhook 监听器支持以下身份验证类型:
- 无身份验证
- Google 身份验证:确保服务账号具有 roles/connectors.listener 角色,其访问令牌用于身份验证。
- API 密钥身份验证
- 基本身份验证
- 事件类型字段位置:必需字段,表示与传入事件请求关联的事件类型所在的位置(标头、查询参数或请求正文)。
- 事件类型字段名称:配置位置中的必填字段,用于标识与传入事件请求关联的事件类型。
- 选择启用专用连接,以便在后端应用与连接之间建立安全连接。如果您选择此选项,则必须在创建连接后执行其他配置步骤。如需了解详情,请参阅用于事件订阅的专用连接。
- 输入死信配置。如果您配置了死信,连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息:
- 退信项目 ID :您配置退信 Pub/Sub 主题的 Google Cloud 项目 ID。
- 死信主题 :您要将未处理事件的详细信息写入的 Pub/Sub 主题。
- 点击下一步。
在上面的示例中,请求正文中的 event_type 字段表示该请求与“user.created”事件相关。{ "event_type": "user.created", ... // other request fields ... }
- 监听器身份验证:为事件监听器选择身份验证类型,然后输入相关详细信息。
- 查看:查看您的连接和监听器身份验证详细信息。
- 点击创建。
在集成中使用 Webhook 连接
创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。
- 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务。
- 如需了解如何在 Application Integration 中创建和使用连接器任务,请参阅连接器任务。