Skip to Content
Webhook eventsDocuments

document.comment.created

Fires when a workspace member or a party comments on a document, in a new thread or as a reply. data.object is the comment and data.thread the thread it belongs to. Internal threads, which only the workspace sees, fire it too; data.thread.visibility tells them apart.

Header Parameters

webhook-id*string

The event id. It stays the same across retries and replays, so deduplicate on it.

webhook-timestamp*string

When sajn sent this attempt, in Unix seconds. Reject a timestamp older than your tolerance, such as five minutes.

webhook-signature?string

One or more space-separated signatures, v1,<base64 HMAC-SHA256>, over <webhook-id>.<webhook-timestamp>.<raw request body>. The key is the base64 decoding of the secret after whsec_. Accept the request when any signature matches; for 24 hours after a secret rotation, there is one per secret. Any Standard Webhooks library verifies it. Webhooks created without a secret don't send this header.

Sajn-Version*"2026-10"

The endpoint's API version, the same value as apiVersion in the body.

Value in"2026-10"

Request Body

application/json
  1. body
id*string

Event ID, also in webhook-id. It's the same on every retry, replay and endpoint that receives the event, so deduplicate on it. To read the event again, pass it to GET /api/v1/events/{id}.

type*"document.comment.created"
Value in"document.comment.created"
createdAt*string

When the event happened. It doesn't change across retries and replays.

Formatdate-time
apiVersion*"2026-10"

The endpoint's API version, which sets the shape of data.

Value in"2026-10"
workspaceId*string
organizationId*string

The organization the event happened in.

environment*string

SANDBOX for an event in a sandbox organization.

Value in"PRODUCTION""SANDBOX"
actor*|null
data*

Response Body

Return any 2xx status code within 30 seconds to acknowledge the delivery. sajn retries any other status code, a redirect, a timeout and a network error with backoff for about three days, 12 attempts in all. A 410 Gone stops the retries and pauses the webhook.

Example Requests
POST/document.comment.created
Request Body
application/json
{  "id": "cm4k2x9p10014abcd1234efgh",  "type": "document.comment.created",  "createdAt": "2026-09-28T14:03:00.000Z",  "apiVersion": "2026-10",  "workspaceId": "cm4k2x9p10001abcd1234efgh",  "organizationId": "cm4k2x9p10000abcd1234efgh",  "environment": "PRODUCTION",  "actor": {    "type": "USER",    "id": "cm4k2x9p10002abcd1234efgh"  },  "data": {    "object": {      "id": "cm4k2x9p10019abcd1234efgh",      "threadId": "cm4k2x9p10018abcd1234efgh",      "parentId": null,      "body": "Kan vi ändra startdatumet till den 1 december?",      "mentions": [],      "createdAt": "2026-09-28T14:03:00.000Z",      "editedAt": null,      "deletedAt": null,      "author": {        "type": "SIGNER",        "id": "cm4k2x9p10004abcd1234efgh",        "name": "Kai Lindqvist",        "email": "kai@example.com"      }    },    "thread": {      "id": "cm4k2x9p10018abcd1234efgh",      "documentId": "cm4k2x9p10003abcd1234efgh",      "status": "OPEN",      "visibility": "SHARED",      "excerpt": "Anställningen börjar den 1 november 2026.",      "createdAt": "2026-09-28T14:03:00.000Z",      "updatedAt": "2026-09-28T14:03:00.000Z",      "resolvedAt": null,      "createdBy": {        "id": "cm4k2x9p10004abcd1234efgh",        "name": "Kai Lindqvist",        "email": "kai@example.com"      },      "resolvedBy": null    }  }}
Header Parameters
{  "webhook-id": "cm4k2x9p10014abcd1234efgh",  "webhook-timestamp": "1759304580",  "webhook-signature": "v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=",  "Sajn-Version": "2026-10"}

Was this page helpful?