跳到主要内容
Mix SpaceMix Space

Webhook 与事件通知

配置 Webhook 将 Mix Space 的内容事件推送到外部服务,实现自动化集成

Webhook 可以将 Mix Space 中发生的事件(如发布文章、收到评论等)实时推送到你指定的外部服务。常见的用途包括:通知到 Telegram/微信、触发 CI/CD 构建、同步到第三方平台等。

创建 Webhook

进入 Webhook 管理页面

登录后台,进入后台的「Webhooks」页面。

点击新建

填写以下信息:

字段说明
Payload URL接收推送的 URL 地址
Secret签名密钥,用于验证推送来源
事件勾选你关注的事件类型
启用是否启用此 Webhook
作用域选择接收推送的范围(访客/管理员/系统)

保存并测试

保存后,当勾选的事件发生时,系统会向 Payload URL 发送 HTTP POST 请求。

支持的事件

自 v14.0 起,事件标识符已从 POST_CREATE 这种下划线大写形式改为点号小写形式 post.create。服务端会按精确值匹配,写错大小写或分隔符的订阅会被静默丢弃——不报错,但永远收不到推送。如果你从旧版本升级,请按下表逐条核对订阅的事件名。

你也可以随时调用 GET /api/v3/webhooks/events 获取当前版本支持的完整事件列表,该接口直接返回服务端的权威枚举。

内容

事件说明
post.create文章创建
post.update文章更新
post.unpublish文章下架
post.republish文章重新上架
post.delete文章删除
note.create日记创建
note.update日记更新
note.unpublish日记下架
note.republish日记重新上架
note.delete日记删除
page.create页面创建
page.update页面更新
page.delete页面删除
say.create说说创建
say.update说说更新
say.delete说说删除
recently.create速记创建
recently.update速记更新
recently.delete速记删除
category.create分类创建
category.update分类更新
category.delete分类删除
topic.create专题创建
topic.update专题更新
topic.delete专题删除
comment.create评论创建
comment.update评论更新
comment.delete评论删除
link.apply友链申请

AI

事件说明
summary.generatedAI 摘要生成完成
insights.createAI 精读创建
insights.updateAI 精读更新
insights.deleteAI 精读删除
insights.generatedAI 精读生成完成
translation.createAI 翻译创建
translation.updateAI 翻译更新
translation.deleteAI 翻译删除

活动与统计

事件说明
activity.like点赞
activity.update_presence在线状态更新
activity.leave_presence离开在线状态
article.read_count_update阅读数变更
visitor.online访客上线
visitor.offline访客离线
aggregate.update聚合统计更新

协作与系统

事件说明
draft.update草稿被其他会话更新(用于检测并发编辑冲突)
task.update任务队列状态变更
admin.notification后台通知
content.refresh内容已更新或重置,页面需要重新加载
image.refresh图片刷新
image.fetch图片拉取
auth.failed认证失败
gateway.connect实时通道建立连接
gateway.disconnect实时通道断开连接
ai_agent.messageAI Agent 消息
ai_agent.tool_eventAI Agent 工具调用事件
ai_agent.confirm_requestAI Agent 请求确认
ai_agent.confirm_resultAI Agent 确认结果
ai_agent.session_stateAI Agent 会话状态变更
companion_presence.changedCompanion 在线状态变更

云函数广播事件使用 fn. 前缀(例如 fn.你的函数名),不走 Webhook 订阅列表。

作用域说明

Webhook 可以选择不同的推送作用域:

作用域值说明
访客TO_VISITOR仅推送面向访客的事件
管理员TO_ADMIN仅推送面向管理员的事件
系统TO_SYSTEM仅推送系统级别的事件
访客 + 管理员TO_VISITOR_ADMIN面向访客或管理员的事件
访客 + 系统TO_SYSTEM_VISITOR系统事件或面向访客的事件
管理员 + 系统TO_SYSTEM_ADMIN系统事件或面向管理员的事件
全选ALL推送所有事件

后台界面通常只提供「访客 / 管理员 / 系统 / 全选」四项,其余组合可通过 API 订阅时直接传入。

合理选择作用域可以减少不必要的推送请求。例如,如果你想将评论通知推送到 Telegram,选择「访客」作用域即可。

管理推送记录

在 Webhook 列表中点击某个 Webhook,可以查看该 Webhook 的推送记录:

  • 推送状态:成功或失败
  • HTTP 状态码:目标服务返回的状态码
  • 请求头和请求体:完整的推送内容
  • 响应内容:目标服务的返回数据

重试推送

对于推送失败的记录,可以点击「重新推送」按钮手动重试。

清除记录

点击「清除记录」可以删除该 Webhook 的所有历史推送记录。