Collaboration snapshots

When an editing session ends, a collaboration snapshot is created. It includes all the necessary data for debugging and retrieval of the document when required. The snapshot data is encrypted with a key unique for each environment. Snapshots and related data are permanently removed after 30 days.

The collaboration snapshots feature can be helpful when solving difficult-to-reproduce cases related to documents. For example:

• When data is stored on the user’s side, relying on webhooks. When an issue occurs with webhook delivery, the data might be potentially lost.
• Issues related to the use of an erroneous editor bundle.
• Issues related to operation corrupting the document.
• Other cases introducing irreversible changes to the document.

The collaboration snapshots are available by using the REST API.

To debug and/or retrieve the document, the CKEditor team needs you to provide a zip containing these 3 files:

• The document snapshot .json
• The editorBundle
• The config

To retrieve your document’s snapshot, follow these steps:

1. Get a list of snapshots existing for the selected document. Use the REST API GET metadata endpoint.
2. Use the selected snapshot’s metadata to retrieve it and save it as .json. Use the REST API GET snapshots endpoint.
3. Get editorBundle. Use the REST API Get editor bundle endpoint.
4. Get config. Use the REST API Get editor bundle config endpoint.
5. Send editorBundle, config, and snapshot to our team.

When the CKEditor team retrieves operations from your document, you will receive a file with your document’s content in HTML. Use the retrieved data to create a new editing session by sending a request to this REST API endpoint.

If you have any feedback regarding this feature, feel free to contact us.