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