Comments

Create a comment

Adds a comment to a project, web app or document in the key's workspace. The comment is attributed to a guest author named API, is not private, and gets the next comment number. It triggers a comment.created event with source set to connector:<key_id>; webhook subscriptions created with the same key do not receive it. Requires the write scope.

post/comments

Request

  • Base URL: https://app.huddlekit.com/api/v1
  • URL: https://app.huddlekit.com/api/v1/comments
  • Auth: HTTP bearer

Request body

parent_idstring uuid required

Id of the project, web app or document to comment on (from GET /projects). Must belong to the key's workspace.

project_idstring uuid

Deprecated alias of parent_id, used only when parent_id is absent.

surface'website' | 'webapp' | 'document'

What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).

textstring required

Comment text. Must not be blank. At most 10,000 characters.

status'open' | 'in-review' | 'in-progress' | 'resolved'

Workflow status of a comment. Setting resolved also marks the comment resolved; any other value marks it unresolved.

pathstring

Website and webapp only. Page path the comment is about, such as /pricing. Sanitized before it is stored. Defaults to / for a website, and to the path of url (or /) for a web app. Ignored for documents.

urlstring uri

Webapp only. Full http:// or https:// URL of the page on your site that the comment is about.

page_titlestring

Webapp only. Title of the page. Trimmed; at most 500 characters.

page_numberinteger

Document only. Page number, 1 or more. Defaults to 1.

video_timestampnumber

Document only, and only when the document is a video. Position in seconds, 0 or more.

Example request

{
  "parent_id": "0d3c7a52-9e61-4f0b-8a2d-5b7e1c4f9a36",
  "surface": "website",
  "text": "Hero headline wraps badly at 1024px.",
  "path": "/"
}

Response

The comment was created.

surface'website' | 'webapp' | 'document' required

What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).

Example response

{
  "comment": {
    "id": "6b1f9c2e-4d7a-4c1b-9e3f-2a8d5c7b1e04",
    "comment_number": 43,
    "text": "Hero headline wraps badly at 1024px.",
    "status": "open",
    "created_at": "2026-09-27T08:00:00.000Z"
  },
  "surface": "website"
}

Changes

No recorded changes to this operation across all 1 revision of this API.