创建并管理拥护者 webhook 订阅

Webhook 是在事件发生时执行的代码。Advocate 允许您使用 webhooks 注册一个 URL，每当程序中发生事件时我们会向该 URL 发送 POST 请求，例如，当为新参与者创建自定义优惠码时，会创建一个事件对象。有两种创建和管理 webhooks 的方法： 通过 Advocate API 或在 Advocate 平台中。本文将说明如何通过 Advocate 平台管理 webhooks。

创建 webhook 订阅

1. 从顶部导航栏，选择 [用户资料] → 设置.

2. 在下方左侧栏中 Advocate 设置下，选择 Webhooks.

3. 在 Webhook 订阅 页面，选择 创建订阅.

4. 下方 发布到 URL，输入应用用于发送有关特定事件实时更新的唯一地址。

5. 可选地，在下面 Webhook 名称中，输入新 webhook 订阅的名称。

6. 选择 保存.

排查 webhook 日志

当您注册一个 URL，使得 Advocate 在程序中发生事件时向其发送 POST 时，您可以查看日志并排查任何失败的 webhook 事件。

访问您的 webhook 日志

1. 从顶部导航栏，选择 [用户资料] → 设置.

2. 在下方左侧栏中 Advocate 设置下，选择 Webhooks.

3. 在 Webhook 订阅 页面，选择 查看日志.

4. 使用下面的筛选器 Webhooks 事件日志 来筛选 webhooks。

   • 请参阅 筛选参考 有关更多信息，请参见下方。

筛选参考

筛选器	说明
类型	筛选该 webhook 事件类型。此筛选默认设置为 所有类型.
时期	筛选 webhook 最后更新的时期。此筛选默认设置为 所有时间.

查看 webhook 详细信息

1. 选择特定的 webhook 以打开 Webhook 详细信息 视图。

2. 此视图提供可用于排查 webhook 订阅的问题的信息。

   • 请参阅 事件参考 有关更多信息，请参见下方。

事件参考

筛选器	说明
类型	该 webhook 事件类型.
Webhook ID	该 webhook 的唯一标识符。
创建日期	创建该 webhook 的日期。
事件数据	该 webhook 有效负载.
订阅	接收该 webhook 的 webhook 订阅及其状态。
订阅详情	有关从 webhook 订阅端点收到的响应的详细信息。详细信息可以包括 webhook 的投递尝试，显示尝试的时间戳、从目标收到的 HTTP 状态码，以及由于请求等待目标服务器响应时间过长而导致尝试超时的情况。

针对失败事件投递的 webhook 重试系统

• REST 钩子在事件触发后会立即投递。如果端点未能成功响应投递尝试（即未以 200 状态码响应），则该次投递将被视为失败。

• 失败的投递将在上一次失败尝试后每小时重试一次，直到要么成功投递，要么已进行 72 次尝试（按每小时重试一次的频率约为 3 天）。

• 持续返回错误的 webhook 端点将在出现以下数量的错误后被自动禁用：

  状态码	收到的错误
  4xx 错误	1000
  5xx 错误	2000
  3xx 错误	2000