本文档由石墨办公提供。

消息推送

概述

此接口用于用户在石墨文件中触发特定行为时，向接入方发送通知。

目前会推送的事件：

评论 (Comment)

讨论 (Discussion)

提及 (MentionAt @人)

日期提醒 (DateMention)

文件内容更新 (FileContent)

文档协作者协同状态变化

版本 (Revision)

系统事件 (System)

回调请求错误

典型场景

用户打开、退出文档：协作者协同状态变化

用户更新文档：文件内容更新

用户增加评论：评论

用户被@：提及

设置日期提醒：日期提醒

请求地址

POST /events

HTTP Request Headers

Header 名	值	说明
X-Weboffice-Token	接入方提供的 Token	用于接入方对本次请求鉴权
X-Shimo-Sdk-Event	Comment	用于识别具体的事件类型

HTTP Response Code
200

HTTP Response Body
空 json，无需返回内容。

请求参数和请求体根据不同事件有所不同。

修改于 2026-08-27 02:37:44

按关键字搜索文件和用户列表