创建通知 Webhook

在线编辑

通知 webhook 是外部 API 调用，用于在发生特定事件时将数据发送给第三方。

关于此任务

您可以配置要调用的外部 API 的请求 URL ，并添加启动该请求所需的任何请求头或参数 URL。 有关事件负载的信息，请参阅 “事件类型和负载 ”。

在 webhook 配置 JSON 中，存在一个属性 notification 。 此属性是一个嵌套 JSON 对象，它包含所有特定于通知的配置选项。 interests 属性是在此 notification 对象中定义的。 发生事件时，系统将针对 interests 属性中的每个元素进行检查。 如果该 interests 属性中的任何元素评估结果与条件匹配，则会将事件发送至 webhook 接收端。 兴趣项将按顺序进行检查，因此在高性能使用场景中，请将匹配范围最广的项放在最前面。

关注项由以下两个字段组成：友好 name 和 clauses 列表。 这些条款决定了该兴趣是否匹配。 这些子句通过“且 AND ”连接，只有当它们全部满足时，条件才成立。 一个子句由三个字段组成：

  • key
  • value
  • operation - 有效值为 include 和 exclude。
该键是一个 JSON 属性名称，用于指定在事件的哪个位置判断该子句是否匹配。 该键可用于评估顶级键或事件数据对象内的键。 在引用数据对象时，使用 JSON 点表示法，例如 data.action. 该值即为正在检查的字段的期望值。 该运算符表示该子句的匹配结果会导致该事件被包含还是被排除。

例如，当认证事件是主要关注点，但您希望过滤掉通过联合身份验证发生的认证时，请使用以下子句：

  • Key: event_type, Value: authentication, Operation: include
  • Key: data.subtype, Value: federation, Operation: exclude

这些子句将进行逻辑求值：

event_type 是 authentication 和 data.subtype 不是 federation。

如需了解更多信息，请参阅 “通知 webhook”。

过程

  1. 转到 “集成” > “通知 webhook”。
  2. 点击 “创建 webhook ”。
  3. 提供 Webhook 的名称。
    您还可指定所有者和电子邮件联系人信息。
  4. 为 API 指定一个或多个请求 URL。
  5. 选择认证的类型。
    基本
    指定用户名和密码。
    页眉
    指定标头名称和认证私钥。 如果私钥是区分大小写的，请选中区分大小写复选框。
    无
    不需要认证信息。
    OAuth
    指定令牌端点，选择客户机私钥是 post 还是 basic，然后输入客户机标识和私钥。
    注： 客户端的帖子显示，该密钥是以属性的形式存储的。 客户机 basic 指示私钥存储在标头中。
    JSON Web 令牌 (JWT)
    请指定 HTTP 标头值、子声明、JWT的最大有效期以及签名算法。 如果需要，您还可以指定 JWT 标头值的前缀、JWT 标头键以及声明名称。
    Mutual TLS ( mTLS )
    指定 MTLS 证书标签。
  6. 可选： 输入自定义的标题和值。
  7. 可选： 启用死信功能。
    “死信”功能用于记录未送达的通知。
    1. 启用 “自动尝试死信核对” 功能，并选择核对尝试间隔。
      您可以设置每隔 5、15 或 30 分钟重新发送通知。
  8. 单击下一步。
  9. 请指定 Webhook 的事件订阅。
    当您指定的任何事件发生时，系统会为该 webhook 触发一条通知。 选择一个预定义事件或添加自定义事件。 您必须至少指定一个事件。
  10. 可选： 点击 “预定义事件”。
    1. 选中一个或多个预定义事件的复选框。
      • 所有认证事件
      • 失败的认证事件
      • 已修改用户概要文件
      • 已创建用户概要文件
      您选择的事件将显示在 “已选事件 ”的 “详细信息 ”窗格中。
    2. 点击 “添加”。
      您将返回 “事件订阅 ”页面，相关事件会列在 “事件配置 ”部分中。
  11. 可选： 点击 “添加自定义事件 ”。
    1. 请为该活动命名。
      您还可以为该事件添加描述。
    2. 请指定触发该事件的兴趣。
      事件是由属性与值组成的对，必须评估为真才能触发该事件。
    3. 请指定是否包含利息。
      您可以指定 event_type authentication `include` 和 user.type admin `exclude`，以便在每次身份验证事件（非管理员操作）发生时触发 webhook。
    4. 可选： 指定更多兴趣。
  12. 点击 “添加”。
    您将返回 “事件订阅 ”页面，该事件会显示在 “事件配置 ”部分中。
  13. 可选： 添加更多自定义事件。
  14. 点击 “创建”。
    该 Webhook 已列在 “通知 Webhook”页面上，并且该 Webhook 已显示出来。
  15. 可选： 修改 webhook 的事件。
    1. 添加更多自定义和预定义事件。
    2. 编辑活动
      1. 编辑图标选择您要修改的活动，然后点击铅笔图标。
      2. 您可以修改名称或描述。 您可以添加或修改兴趣。
      3. 点击 “更新”。
    3. 圆圈内的减号要删除一个事件，请选中它，然后点击 “删除 ”图标。
  16. 可选： 修改连接详细信息。
    1. 选择 “连接详细信息 ”。
    2. 请修改除 “用途 ”和 “集成版本 ”以外的所有设置。
    3. 测试连接。
    4. 查看健康状况。
    5. 删除该 Webhook。
  17. 如果您进行了任何更改，请点击 “保存更改 ”。
  18. 点击 “通知 Webhook ”可返回 “通知 Webhook”页面。