事件
每个事件对应于 CKEditor 云服务在特定环境中可能发生的特定操作。此外,每个事件都有特定的有效负载格式,其中包含相关的事件信息。
在使用 Webhook 之前,请熟悉该功能的基本原理。您可以在 概述文章 中了解更多有关如何使用 Webhook 的信息。
# 协作
以下事件可能会为协作服务触发。
# 用户已连接
名称:collaboration.user.connected
(以前为 document.user.connected
)
描述:当用户加入协作会话时触发。
# 有效负载
document.id
- 用户连接到的文档的 ID。user.id
- 用户的 ID。connected_users
- 当前连接用户的列表。
# 示例
以下示例展示了一个用户连接到文档后发送的 Webhook 请求。
{
"event": "collaboration.user.connected",
"environment_id": "environment-1",
"payload": {
"user": {
"id": "user-1"
},
"document": {
"id": "document-1"
},
"connected_users": [
{
"id": "user-2"
}
]
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 用户已断开连接
名称:collaboration.user.disconnected
(以前为 document.user.disconnected
)
描述:当用户从活动的协作会话中断开连接时触发。
# 有效负载
document.id
- 用户断开连接的文档的 ID。user.id
- 用户的 ID。connected_users
- 当前连接用户的列表。
# 示例
以下示例展示了一个用户从文档断开连接后发送的 Webhook 请求。
{
"event": "collaboration.user.disconnected",
"environment_id": "environment-1",
"payload": {
"user": {
"id": "user-1"
},
"document": {
"id": "document-1"
},
"connected_users": [
{
"id": "user-2"
}
]
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 协作会话已更新
名称:collaboration.document.updated
描述:每 10 分钟或 5000 个版本触发一次,此时协作会话的内容正在更新。当最后一个用户从协作会话断开连接时,也会发出该事件。
# 有效负载
document.id
- 已更新文档的 ID。document.updated_at
- 文档更新的日期。document.version
- 已更新文档的版本。
# 示例
以下示例展示了一个文档更新后发送的 Webhook 请求。
{
"event": "collaboration.document.updated",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"updated_at": "2019-05-29T08:17:56.761Z",
"version": 2000
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 协作会话更新已导出
名称:collaboration.document.update.exported
描述:每 10 分钟或 5000 个版本触发一次,此时协作会话的内容正在更新。当协作会话结束时,以及当最后一个用户断开连接时,也会触发 Webhook。它包含文档内容会话。所有以下条件必须满足
editorBundle
已上传。- 文档存储功能已禁用。
# 有效负载
document.id
- 已更新文档的 ID。document.updated_at
- 文档更新的日期。document.version
- 已更新文档的版本。document.status
- 导出的状态。document.data
- 文档内容。如果导出协作会话失败,该属性可能为空。document.attributes
- 文档属性对象。当文档已从多根编辑器导出时,该属性可能会被发送。
# 示例
以下示例展示了一个文档更新后发送的 Webhook 请求。
{
"event": "collaboration.document.update.exported",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"exported_at": "2019-05-29T08:17:56.761Z",
"version": 2000,
"status": "success",
"data": "<p>Document content</p>",
"attributes": { "foo": "bar" }
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 协作会话已结束
名称:collaboration.document.finished
描述:当文档的协作会话结束且 文档的临时数据 已被删除时触发。无论文档存储配置如何,Webhook 都会触发。要接收已导出的文档数据,请使用 collaboration.document.exported
Webhook。
# 有效负载
document.id
- 已删除文档的 ID。document.removed_at
- 文档删除的日期。
# 示例
以下示例展示了一个文档的协作会话结束后的 Webhook 请求
{
"event": "collaboration.document.finished",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"removed_at": "2019-05-29T08:17:56.761Z"
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 协作会话已导出
名称:collaboration.document.exported
描述:每当满足以下所有条件时触发
- 协作会话已结束。
- 文档数据已成功导出。
editorBundle
已上传。- 文档存储已禁用。
# 有效负载
document.id
- 已删除文档的 ID。document.data
- 已删除文档的数据。document.removed_at
- 文档删除的日期。document.version
- 已删除文档的版本。document.attributes
- 文档属性对象。当文档已从多根编辑器导出时,该属性可能会被发送。
# 示例
以下示例展示了一个协作会话结束且文档数据已成功导出后的 Webhook 请求
{
"event": "collaboration.document.exported",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"data": "<p>Document content</p>",
"removed_at": "2019-05-29T08:16:12.755Z",
"version": 10,
"attributes": { "foo": "bar" }
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 协作会话导出失败
名称:collaboration.document.export.failed
描述:每当满足以下两个条件时触发:(1) 系统无法在协作会话结束后的文档操作转换。(2) 文档存储已禁用。
# 有效负载
document.id
- 已删除文档的 ID。document.reason
- 文档操作转换失败的原因。document.removed_at
- 文档删除的日期。document.version
- 已删除文档的版本。
# 示例
以下示例展示了一个文档的协作会话结束后的 Webhook 请求,但其中一些操作无法应用
{
"event": "collaboration.document.export.failed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"reason": "general-conversion-fail",
"removed_at": "2019-05-29T08:16:12.755Z",
"version": 10
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 协作会话已恢复
名称:collaboration.document.recovered
描述:当文档的协作会话过期且 文档的临时数据 已被删除,但其中一些文档操作无法应用时触发。只有在 文档存储功能 被禁用时才会发送 Webhook,并且它只会包含已正确应用的操作。
# 有效负载
document.id
- 已删除文档的 ID。document.removed_at
- 文档删除的日期。document.data
- 已删除文档的数据,其中只包含已成功应用的操作。document.version
- 已删除文档的版本。document.attributes
- 文档属性对象。当文档已从多根编辑器导出时,该属性可能会被发送。
# 示例
以下示例展示了一个文档被删除但其中一些操作无法应用后的 Webhook 请求。
{
"event": "collaboration.document.recovered",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"removed_at": "2019-05-29T08:17:56.761Z",
"data": "<p>Document content</p>",
"version": 10,
"attributes": { "foo": "bar" }
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 文档存储
本节中的 Webhook 请求只有在 文档存储 功能已启用并已正确配置时才会发送。
# 文档已保存
名称:storage.document.saved
描述:当文档数据被保存时触发。
# 有效负载
document.id
- 已保存文档的 ID。document.saved_at
- 文档保存的日期。document.download_url
- 下载文档的 URL。document.attributes
- 文档属性对象。当文档已从多根编辑器导出时,该属性可能会被发送。
# 示例
以下示例展示了一个文档保存后的 Webhook 请求。
{
"event": "storage.document.saved",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"saved_at": "2019-05-29T08:17:56.761Z",
"download_url": "/api/v5/environment-1/storage/document-1",
"attributes": { "foo": "bar" }
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 文档保存失败
名称:storage.document.save.failed
描述:当文档数据保存失败时触发。当您在网站上使用不同的编辑器捆绑包或其配置,以及 CKEditor 云服务服务器在相同的 bundleVersion
下时,可能会发生这种情况。有关更多信息,请参阅 编辑器捆绑包 指南。
# 有效负载
document.id
- 文档的 ID。document.failed_at
- 文档保存失败的日期。editor.bundleVersion
- 保存期间使用的编辑器的bundleVersion
。fail.reason
- 文档保存失败的原因。fail.details
- 文档保存失败的详细信息。fail.trace_id
- 文档保存失败的跟踪 ID。
# 示例
以下示例展示了一个文档数据保存失败后的 Webhook 请求。
{
"event": "storage.document.save.failed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"failed_at": "2019-05-29T08:17:56.761Z"
},
"editor": {
"bundleVersion": "some_unique_bundle_version"
},
"fail": {
"reason": "Error while processing document.",
"details": "model-position-fromjson-no-root: Cannot create position for document.",
"trace_id": "trace-id-1"
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 文档已删除
名称:storage.document.removed
描述:当文档数据从存储中删除时触发。可以使用 REST API 调用删除文档(请参阅 存储 REST API 部分),或者当文档存储功能被关闭时删除文档。在您为 SaaS 在 CKEditor 生态系统客户仪表板 中禁用该功能,或为本地部署在管理面板中禁用该功能后,所有已存储的文档都将被删除。
# 有效负载
document.id
- 文档的 ID。document.removed_at
- 文档删除的日期。document.data
- 已删除文档的数据。document.attributes
- 文档属性对象。当文档已从多根编辑器导出时,该属性可能会被发送。
# 示例
以下示例展示了一个文档从存储中删除后的 Webhook 请求。
{
"event": "storage.document.removed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"removed_at": "2019-05-29T08:17:56.761Z",
"data": "<p>Document content</p>",
"attributes": { "foo": "bar" }
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 评论
以下事件可能会为评论服务触发。
# 评论已添加
名称:comment.added
描述:当创建评论时触发。
# 有效负载
document.id
- 添加评论的文档的 ID。comment.id
- 已添加评论的 ID。comment.created_at
- 评论的创建日期。comment.content
– 添加的评论内容。comment.attributes
– 添加的评论属性。comment.thread_id
– 添加评论的线程 ID。comment.user.id
– 评论作者的 ID。comment.thread
– 与评论存档功能相关数据的可选字段。comment_thread.id
– 添加的评论线程 ID。comment.thread.created_at
– 评论线程创建日期。comment.thread.context
– 评论线程的上下文,评论存档功能需要。comment.thread.attributes
– 添加的评论线程属性。
# 示例
以下示例展示了在添加评论后发送的 webhook 请求。
{
"event": "comment.added",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment": {
"id": "comment-1",
"created_at": "2019-05-29T08:17:53.450Z",
"content": "Some comment content.",
"attributes": { "foo": "bar" },
"thread_id": "thread-1",
"user": {
"id": "user-1"
},
"thread": {
"id": "thread-1",
"created_at": "2019-05-29T08:17:53.450Z",
"context": {
"type": "value"
},
"attributes": {
"attribute": "value"
}
}
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论更新
名称:comment.updated
描述:当评论被更新时触发。
# 有效负载
document.id
– 更新评论所在的文档 ID。comment.id
– 更新的评论 ID。comment.updated_at
– 评论更新日期。comment.content
– 更新后的评论内容。comment.old_content
– 更新前的评论内容。comment.attributes
– 更新后的评论属性。comment.old_attributes
– 更新前的评论属性。comment.thread_id
– 更新评论所在的线程 ID。comment.user.id
– 更新评论的作者 ID。comment.thread
– 与评论存档功能相关数据的可选字段。comment_thread.id
– 添加的评论线程 ID。comment.thread.created_at
– 评论线程创建日期。comment.thread.context
– 评论线程的上下文,评论存档功能需要。comment.thread.resolved_at
– 评论线程解决日期。仅在评论线程被解决时发送。comment.thread_resolved_by
– 解决评论线程的用户 ID。仅在评论线程被解决时发送。comment.thread.attributes
– 添加的评论线程属性。
# 示例
以下示例展示了在评论被更新后发送的 webhook 请求。
{
"event": "comment.updated",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment": {
"id": "comment-1",
"updated_at": "2019-05-29T08:17:53.450Z",
"content": "Some comment content.",
"old_content": "Some old comment content.",
"attributes": {
"foo": "new"
},
"old_attributes": {
"foo": "old"
},
"thread_id": "thread-1",
"user": {
"id": "user-1"
},
"thread": {
"id": "thread-1",
"created_at": "2019-05-29T08:17:53.450Z",
"context": {
"type": "value"
},
"resolved_at": "2019-05-29T08:17:53.450Z",
"resolved_by": "user-1",
"attributes": {
"attribute": "value"
}
}
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论删除
名称:comment.removed
描述:当评论被删除时触发。
# 有效负载
document.id
– 删除评论所在的文档 ID。comment.id
– 删除的评论 ID。comment.removed_at
– 评论删除日期。comment.user.id
– 删除评论的用户 ID。
# 示例
以下示例展示了在评论被删除后发送的 webhook 请求。
{
"event": "comment.removed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment": {
"id": "comment-1",
"removed_at": "2019-05-29T08:17:53.450Z",
"user": {
"id": "user-1"
}
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程添加
名称:commentthread.added
描述:当评论线程被添加时触发。
# 有效负载
document.id
– 添加评论线程所在的文档 ID。comment_thread.id
– 添加的评论线程 ID。comment_thread.comments
– 添加的评论线程中的评论列表。comment_thread.created_at
– 评论线程创建日期。comment_thread.context
– 评论线程的上下文,评论存档功能需要。comment_thread.attributes
– 添加的评论线程属性。
# 示例
以下示例展示了在评论线程被添加后发送的 webhook 请求。
{
"event": "commentthread.added",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_thread": {
"id": "comment-thread-1",
"comments": [
{
"id": "comment-1",
"attributes": {
"foo": "bar"
},
"content": "Some comment content",
"user_id": "user-1",
"created_at": "2019-05-29T08:17:53.450Z"
}
],
"created_at": "2019-05-29T08:17:53.450Z",
"context": {
"type": "value"
},
"attributes": {
"attribute": "value"
}
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程更新
名称:commentthread.updated
描述:当评论线程被更新时触发。
# 有效负载
document.id
– 更新评论线程所在的文档 ID。comment_thread.id
– 更新的评论线程 ID。comment_thread.comments
– 更新后的评论线程中的评论 ID 列表。comment_thread.updated_at
– 评论线程更新日期。comment_thread.context
– 更新后的评论线程上下文,评论存档功能需要。comment_thread.attributes
– 更新后的评论线程属性。
# 示例
以下示例展示了在评论线程被更新后发送的 webhook 请求。
{
"event": "commentthread.updated",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_thread": {
"id": "comment-thread-1",
"comments": [
{
"id": "comment-1"
}
],
"updated_at": "2019-05-29T08:17:53.450Z",
"context": {
"type": "value"
},
"attributes": {
"attribute": "value"
}
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程解决
名称:commentthread.resolved
描述:每当评论线程被解决时触发。
# 有效负载
document.id
– 解决评论线程所在的文档 ID。comment_thread.id
– 被解决的评论线程 ID。comment_thread.comments
– 被解决的评论线程中的评论 ID 列表。comment_thread.resolved_at
– 评论线程被解决的日期。comment_thread.resolved_by
– 解决评论线程的用户 ID。
# 示例
以下示例展示了在评论线程被解决后发送的 webhook 请求。
{
"event": "commentthread.resolved",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_thread": {
"id": "comment-thread-1",
"comments": [
{
"id": "comment-1"
}
],
"resolved_at": "2019-05-29T08:17:53.450Z",
"resolved_by": "user-1"
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程重新打开
名称:commentthread.reopened
描述:每当评论线程被重新打开时触发。
# 有效负载
document.id
– 重新打开评论线程所在的文档 ID。comment_thread.id
– 被重新打开的评论线程 ID。comment_thread.comments
– 被重新打开的评论线程中的评论 ID 列表。comment_thread.reopened_at
– 评论线程被重新打开的日期。
# 示例
以下示例展示了在评论线程被重新打开后发送的 webhook 请求。
{
"event": "commentthread.reopened",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_thread": {
"id": "comment-thread-1",
"comments": [
{
"id": "comment-1"
}
],
"reopened_at": "2019-05-29T08:17:53.450Z"
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程删除
名称:commentthread.removed
描述:当评论线程被删除时触发。
# 有效负载
document.id
– 删除评论线程所在的文档 ID。comment_thread.id
– 被删除的评论线程 ID。comment_thread.removed_at
– 评论线程删除日期。comment_thread.comments
– 被删除的评论线程中的评论列表。
# 示例
以下示例展示了在评论线程被删除后发送的 webhook 请求。
{
"event": "commentthread.removed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_thread": {
"id": "comment-thread-1",
"removed_at": "2019-05-29T08:17:53.450Z",
"comments": [
{
"id": "comment-1"
}
]
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程恢复
名称:commentthread.restored
描述:当评论线程被恢复时触发。评论线程可以通过删除文档中的文本被删除。撤消操作可以恢复删除的文本,也可以恢复评论线程。
# 有效负载
document.id
– 恢复评论线程所在的文档 ID。comment_thread.id
– 被恢复的评论线程 ID。comment_thread.restored_at
– 评论线程恢复日期。comment_thread.comments
– 被恢复的评论线程中的评论列表。
# 示例
以下示例展示了在评论线程被恢复后发送的 webhook 请求。
{
"event": "commentthread.restored",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_thread": {
"id": "comment-thread-1",
"restored_at": "2019-05-29T08:17:53.450Z",
"comments": [
{
"id": "comment-1"
}
]
}
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 评论线程全部删除
名称:commentthread.all.removed
描述:当文档中的所有评论线程被删除时触发。
# 有效负载
document.id
– 删除评论线程所在的文档 ID。comment_threads
– 被删除的评论线程列表。comment_threads[].id
– 被删除的评论线程 ID。comment_thread[].removed_at
– 评论线程删除日期。comment_thread[].comments
– 被删除的评论线程中的评论列表。
# 示例
以下示例展示了在文档中所有评论线程被删除后发送的 webhook 请求。
{
"event": "commentthread.all.removed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "doc-1"
},
"comment_threads": [
{
"id": "comment-thread-1",
"removed_at": "2019-05-29T08:17:53.450Z",
"comments": [
{
"id": "comment-1"
}
]
},
{
"id": "comment-thread-2",
"removed_at": "2019-05-29T08:17:53.450Z",
"comments": [
{
"id": "comment-2"
}
]
}
]
},
"sent_at": "2019-05-29T08:17:53.457Z"
}
# 建议
以下事件可以为“修订跟踪”服务触发。
# 建议添加
名称:suggestion.added
描述:每当建议被添加时触发。
# 有效负载
document.id
– 添加建议所在的文档 ID。suggestion.id
– 建议的 ID。suggestion.created_at
– 建议的创建日期。suggestion.child_of
– 父建议的 ID 或 null。suggestion.user.id
– 建议的作者 ID。
# 示例
以下示例展示了在建议被添加后发送的 webhook 请求。
{
"event": "suggestion.added",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1"
},
"suggestion": {
"id": "suggestion-1",
"created_at": "2019-05-29T08:17:53.450Z",
"child_of": null,
"user": {
"id": "user-1"
}
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 建议接受
名称:suggestion.accepted
描述:每当建议被接受时触发。
# 有效负载
document.id
– 添加建议所在的文档 ID。suggestion.id
– 建议的 ID。suggestion.created_at
– 建议的创建日期。suggestion.updated_at
– 建议更新/接受的日期。suggestion.user.id
– 接受建议的用户 ID。
# 示例
以下示例展示了在建议被接受后发送的 webhook 请求。
{
"event": "suggestion.accepted",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1"
},
"suggestion": {
"id": "suggestion-1",
"created_at": "2019-05-29T08:17:53.450Z",
"updated_at": "2019-05-29T08:17:53.450Z",
"user": {
"id": "user-1"
}
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 建议拒绝
名称:suggestion.rejected
描述:每当建议被拒绝时触发。
# 有效负载
document.id
– 添加建议所在的文档 ID。suggestion.id
– 建议的 ID。suggestion.created_at
– 建议的创建日期。suggestion.updated_at
– 建议更新/拒绝的日期。suggestion.user.id
– 拒绝建议的用户 ID。
# 示例
以下示例展示了在建议被拒绝后发送的 webhook 请求。
{
"event": "suggestion.rejected",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1"
},
"suggestion": {
"id": "suggestion-1",
"created_at": "2019-05-29T08:17:53.450Z",
"updated_at": "2019-05-29T08:17:53.450Z",
"user": {
"id": "user-1"
}
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 建议删除
名称:suggestion.removed
描述:当删除建议时触发。
#有效负载
document.id
– 从中删除建议的文档的 ID。suggestion.id
– 建议的 ID。suggestion.deleted_at
– 建议的删除日期。
# 示例
以下示例展示了删除建议后发送的 Webhook 请求。
{
"event": "suggestion.removed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1"
},
"suggestion": {
"id": "suggestion-1",
"deleted_at": "2019-05-29T08:17:53.450Z"
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 建议已恢复
名称:suggestion.restored
描述:当恢复建议时触发。可以通过删除文档中的文本来删除建议。撤消操作可以恢复已删除的文本,也可以恢复建议。
# 有效负载
document.id
– 恢复建议的文档的 ID。suggestion.id
– 建议的 ID。suggestion.restored_at
– 建议的恢复日期。
# 示例
以下示例展示了恢复建议后发送的 Webhook 请求。
{
"event": "suggestion.restored",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1"
},
"suggestion": {
"id": "suggestion-1",
"restored_at": "2019-05-29T08:17:53.450Z"
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}
# 已弃用
已弃用的事件保留是为了向后兼容,但是不建议在新的处理程序中使用它们。
# 协作会话已删除
替换为:collaboration.document.finished
和 collaboration.document.exported
名称:collaboration.document.removed
(以前为 document.removed
)
描述:当文档的协作会话过期且文档的临时数据被删除时触发。
# 有效负载
document.id
- 已删除文档的 ID。document.removed_at
- 文档删除的日期。document.data
– 已删除文档的数据。这是一个可选参数,当文档存储功能被禁用且editorBundle
被上传到环境时,会设置该参数。如果某些操作无法应用于文档,则data
属性为空,并且会发出collaboration.document.recovered
webhook。
# 示例
以下示例展示了删除文档后发送的 Webhook 请求。
{
"event": "collaboration.document.removed",
"environment_id": "environment-1",
"payload": {
"document": {
"id": "document-1",
"removed_at": "2019-05-29T08:17:56.761Z",
"data": "<p>Document content</p>"
}
},
"sent_at": "2019-05-29T08:17:56.761Z"
}