版本
开发中POST
{endpoint_url}/events当有用户创建、修改、删除版本并被服务器处理成功后,推送此事件。
事件可通过 action
的值区分用户行为:
create
用户创建版本时,触发此事件update
用户修改版本时,触发此事件delete
用户删除版本时,触发此事件
请求参数
Path 参数
endpoint_url
string
必需
示例值:
{{endpoint_url}}
Header 参数
X-Shimo-Token
string
必需
用于接入方对本次请求鉴权
X-Shimo-Sdk-Event
string
必需
用于识别具体的事件类型
Body 参数application/json
kind
string
必需
action
string
必需
fileId
string
接入方文件 ID
userId
string
接入方用户 ID
revision
object
必需
revisionId
integer
必需
title
string
必需
label
string
必需
docHistoryId
string
必需
timestamp
integer
此事件产生的时间
示例
{
"kind": "revision",
"action": "create",
"fileId": "file1", // 接入方文件 ID
"userId": "user1", // 接入方用户 ID
"revision": {
// 事件对应版本的 id
"revisionId": 1348,
// 版本的标题
"title": "无标题",
// 版本的标签
"label": "2022/2/28 星期一 18:12",
// 文档版本的 id
"docHistoryId": "621c9ff51125670006875854"
},
"timestamp": 1635732089224 // 此事件产生的时间
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
object {0}
示例
{}
最后修改时间: 8 个月前