Help > Forum > 網站集成 > 使用网钩

使用网钩

使用 webhooks 来通知您论坛中发生的事件。

当事件发生时-例如,当新用户在您的论坛上创建一个帐户时-Website Toolbox会创建一个事件对象。 此对象包含有关刚刚发生的事件的所有相关信息,包括事件的类型和与该事件关联的数据。 然后,我们通过 HTTP POST 请求将事件对象作为 JSON 发送到您的网络挂钩网址。

网络钩子结合使用时非常好 论坛 API。 例如,webhook 可以在新用户注册您的论坛时通知您的应用程序,然后您可以使用 API 修改该用户的论坛帐户。

当前支持以下事件:用户。创建,用户。批准,用户。更新,用户。删除,用户。确认,用户。支付。收到,用户。支付_订阅开始,用户。支付_订阅结束,主题。更新,主题。更新,主题。删除,创建,发布。创建,发布。批准,发布。更新,发布。删除,发布。 对话。创建和消息。创建。 -拜托 让我们知道 如果你需要某个新的 webhook 事件。


配置您的网络挂钩设置

  1. 登录到您的Website Toolbox帐户。
  2. 点击 设置 链接。
  3. 设置 菜单中,单击 通知 链接。
  4. 在旁边的文本框中输入您的网络挂钩网址 韦伯胡克 选项。

响应网络钩子

要确认接收 webhook,您的终端节点应返回 2xx HTTP 状态代码。 请求标头或请求正文中返回的任何其他信息将被忽略。 此范围以外的所有响应代码(包括 3xx 代码)将表明您未收到 webhook。 这确实意味着 URL 重定向或 “未修改” 响应将被视为失败。

如果因任何原因未能成功接收 webhook,我们将继续尝试每小时发送一次 webhook,长达 3 天。


示例事件

{
  "api_version": "1",
  "data": {
    "object": {
      "signature": "Thanks, John.",
      "name": "John Doe",
      "allowEmails": false,
      "lastPostTimestamp": 0,
      "userGroups": [7440, 2452, 52423],
      "userTitle": "Power User",
      "reputation": 423,
      "username": "john",
      "postCount": 32,
      "userId": 181855,
      "lastVisitTimestamp": 1322811119,
      "instantMessagingType": "",
      "instantMessagingId": "",
      "object": "User",
      "invisible": false,
      "email": "johnDoe@gmail.com",
      "avatarUrl": "https://test.com/images/avatar.png",
      "joinDateTimestamp": 1322811119,
      "enableMessages": true
    }
  },
  "object": "event",
  "id": 1534,
  "type": "user.created",
  "mode": "live"
}

查看网络挂钩事件和响应

您可以按照以下说明查看发送到您的 webhook 的事件和从您的 webhook 收到的响应:

  1. 登录到您的Website Toolbox帐户。
  2. 点击 将军 链接。
  3. 将军 菜单中,单击 韦伯胡克 链接。(如果没有 韦伯胡克 链接,这意味着网络钩子 URL 没有在 网络挂钩设置 尚未。)


If you still need help, please contact us.