Webhook 负载

支持
1

我们考虑使用 Webhook 来发送特定类型事件的数据，用于指标分析。这些事件的负载（payload）是否有文档说明？还是说 Webhook 的负载与 Discourse API 中的负载完全一致？

例如，如果我们为“用户事件”设置一个 Webhook，那么其负载是否会包含 /admin/users/list/{flag}.json 接口返回的所有标准用户 JSON 数据，还是会有所不同？同样的问题也适用于帖子事件（对应 /posts.json 接口）和话题事件（对应 /latest.json 接口）。

此外，我知道在使用上述用户接口时，可以通过 API 指定 show_emails=true 参数。那么，Webhook 返回的负载中是否包含邮箱地址？

2

据我所知，没有列出 webhook 负载的清单。这些负载与你在 Discourse API 文档中看到的类似，但某些字段并未包含在负载中，而在少数情况下还会添加额外的字段。

我知道的最简单查看负载内容的方法是：在 Discourse 上配置一个指向 http://example.com 的 webhook，然后在网站上执行某个操作以触发该 webhook。之后，你可以点击 webhook 事件列表中的“请求”（Request）按钮来查看负载：

image
image1160×670 42.2 KB

该截图展示的是用户事件（User Event）webhook 的负载。你会看到用户的电子邮件地址已包含在负载中。

3

谢谢，我已经设置好了测试 Webhook，现在可以收到负载数据了。