Help > Forum > 網站集成 > 使用 Webhook
使用 Webhook
使用 webhook 获取有关论坛中发生的事件的通知。
当事件发生时-例如,当新用户在论坛上创建帐户时-Website Toolbox会创建一个事件对象。此对象包含有关刚刚发生的事情的所有相关信息,包括事件类型和与该事件相关的数据。然后,我们通过 HTTP POST 请求将 Event 对象作为 JSON 发送到您的 webhook URL。
当与论坛 API 结合使用时,Webhook 效果很好。例如,当新用户注册论坛时,webhook 可以通知您的应用程序,然后您可以使用 API 修改该用户的论坛帐户。
使用此功能需要论坛增长或专业版计划。
当前支持以下事件:用户。创建、用户。已批准、用户。已更新、已删除、用户 .email。已验证、用户。付款。已接收、用户 .paid_订阅.开始、user.paid_订阅。已结束、主题。已创建、主题。已删除、发布。已批准、发布。更新、帖子。对话。创建和消息。已创建。如果你需要某个新的 webhook 活动,请告诉我们。
配置你的 webhook 设置
- 登录到您的Website Toolbox帐户。
- 单击 集成 链接。
- 单击 Webhook 链接。
- 在旁边的文本框中输入你的 webhook URL Webhook 选项。
回复网络挂钩
要确认收到 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 的事件以及从 webhook 收到的响应:
- 登录到您的Website Toolbox帐户。
- 单击 内容 链接。
- 在 内容 菜单中,单击 Webhook 日志 链接。(如果没有 Webhook 日志 链接,这意味着没有在 webhook 设置 还是。)
If you still need help, please contact us.