[Callback] Snapshot ready

Designing

Staging

POST

/internal/collab/snapshot

Callbacks

Collab-plane → Control-plane callback.

Sent when the collab-plane produces a periodic code snapshot. The control-plane
persists this snapshot for session replay (US-45, US-46) and code diff viewing (US-19).

Snapshots are triggered:

Periodically (every 30 seconds during active editing)

On significant events (phase transitions, code submissions)

On document destruction (final snapshot)

Request

Authorization

API Key

Add parameter in header

X-Internal-Secret

Example:

X-Internal-Secret: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Snapshot acknowledged

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/internal/collab/snapshot' \
--header 'X-Internal-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "roomId": "550e8400-e29b-41d4-a716-446655440000",
    "snapshot": [
        1,
        2,
        3,
        4,
        5
    ],
    "timestamp": 1709467230000
}'

Response Example

{
    "success": true
}

Modified at 2026-03-11 21:59:03

Health check

[Callback] User disconnected