使用 webhook 接收有关论坛中发生的事件的通知。
当事件发生时(例如,当新用户在您的论坛上创建帐户时),网站工具箱会创建一个事件对象。该对象包含有关刚刚发生的事情的所有相关信息,包括事件类型和与该事件相关的数据。然后,我们通过 HTTP POST 请求将事件对象作为 JSON 发送到您的 webhook 网址。
网络挂钩与论坛 API 结合使用时效果很好。例如,当有新用户注册您的论坛时,webhook 可以通知您的应用程序,然后您可以使用 API 修改该用户的论坛帐户。
论坛增长计划或专业版计划必须使用此功能。
配置您的 webhook 设置
- 登录您的网站工具箱账户。
- 单击 “集成” 链接。
- 单击 Webhook 链接。
- 单击 “添加 Webhook” 按钮。
- 输入您的 webhook 网址,然后选择要接收的事件。
- 单击 “保存”。
您可以创建多个 webhook 以将事件发送到不同的 URL。每个 webhook 可以配置为接收不同类型的事件。
回复网络挂钩
查看我们的接收 webhook 事件的示例代码。
要确认收到 Webhook,您的终端节点应返回 2xx HTTP 状态码。请求标头或请求正文中返回的任何其他信息都将被忽略。在此范围之外的所有响应代码,包括 3xx 代码,都将表明您没有收到 webhook。这确实意味着 URL 重定向或 “未修改” 响应将被视为失败。
如果由于任何原因未成功收到 webhook,我们将继续尝试每小时发送一次 webhook,持续最多 3 天。
示例事件
{
“api_version”: “1”,
“数据”:{
“对象”:{“签名”:
“谢谢,约翰。”,
“姓名”:“John Doe”,
“AlloweMails”:false,
“LastPostTimestamp”:0,
“用户组”:[7440、2452、52423],“用户标题”:“超级用户”,“声誉”:423,
“用户名”:“john”,“postCount”:32,
“用户 ID”:181855,
“LastVisitTimestamp”:13228Timestamp”:1322811119,
“InstantMessagingType”:
“”,“InstantMessagingID”:“”,
“对象”:“用户”,“隐身”:false,“电子邮件”:“johnDoe@gmail.com”,
“AvatarUrl”:“https://test.com/images/avatar.png”,
“joinDateTimestamp”:1322811119,
“启用消息”:true
}
},
“对象”:“事件”,“ID”:1534,
“类型”:“用户创建”,
“模式”:“直播”}
查看 webhook 事件和响应
您可以按照以下说明查看发送到您的 webhook 的事件以及从 webhook 收到的响应:
- 登录您的网站工具箱账户。
- 单击 “集成” 链接。
- 单击 Webhook 链接。
- 点击要查看的 Webhook 的事件数量。