Payload and actor reference

Webhook bodies are UTF-8 JSON. The delivery body is snapshotted during fan-out and remains byte-stable across retries. This representative document.updated payload shows the complete envelope and document metadata shape.

{
  "version": 1,
  "deliveryId": "018f65fa-31c0-7f69-9a61-8c10c67e41d4",
  "subscription": {
    "id": "018f65e7-0cf6-76c0-8632-ae28a53eb513",
    "name": "Requirements agent loop",
    "scope": {
      "type": "collection",
      "collectionId": 42,
      "collectionPath": "Requirements"
    }
  },
  "teamId": 7,
  "teamSlug": "acme",
  "event": {
    "id": "018f65fa-3199-7f6c-96ac-353d77640f97",
    "type": "document.updated",
    "occurredAt": "2026-07-15T14:28:10+00:00",
    "actors": [
      {
        "type": "human",
        "userId": 19,
        "displayName": "Maya Chen",
        "agentSessionId": null
      },
      {
        "type": "agent",
        "userId": 19,
        "displayName": "Claude Code",
        "agentSessionId": 381
      }
    ],
    "data": {
      "id": 287,
      "title": "Checkout requirements",
      "path": "Requirements/Checkout requirements-d287.md",
      "collectionId": 42,
      "collectionPath": "Requirements",
      "changes": ["content"],
      "previousTitle": null,
      "previousPath": "Inbox/Checkout requirements-d287.md",
      "previousCollectionId": 11,
      "previousCollectionPath": "Inbox",
      "deletedAt": null,
      "firstHistorySequence": 104,
      "lastHistorySequence": 112,
      "batchStartedAt": "2026-07-15T14:27:10+00:00",
      "batchEndedAt": "2026-07-15T14:28:00+00:00"
    }
  }
}

Actors

type is human, agent, or system. Human actors have a user ID and display name. Agent actors also carry the authorizing user ID and an agentSessionId. System actors may have a null user and session ID. Settled edits may contain multiple distinct actors.

Document data

Document events include id, title, .md path, collection ID/path, and changes. Move, rename, delete, and settled-update events populate the applicable previous, deletion, history-sequence, and batch fields. Unused optional fields are null.

Collection data

Collection events include id, name, path, parentId, changes, and applicable previousName, previousPath, and previousParentId values.

Comment data

Comment events include threadId, commentEventId, threadKind, body, status, documentId, documentTitle, documentPath, and collection ID/path. Creates and replies include the body. Resolution events communicate status and may omit the body.

The payload is routing and change metadata. It intentionally contains no document Markdown and no Yjs update bytes.