Comments
A comment on a card, including a reply inside a thread. Give the text in text and the time in created_at; a reply points at its parent comment with parent_comment_ref, which must be a comment of the same card. If the author is unknown leave author_ref out and put the name in author_name. Files are attachments attached to the comment, and reactions are the emojis of the comment.
A record of this entity needs records of other entities in the package: Cards.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "comments". An entity can have any number of files. See Bundle format.
[
{
"resource": "comments",
"path": "resources/comments.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it.Constraints: 1–512 characters. |
card_ref | Ref<cards> refers to Cards | Yes | The card the comment is on. Give the external_id of a cards record. |
created_at | Timestamp | Yes | When the comment was written, for example 2026-02-02T10:05:00Z.Constraints: RFC 3339 with a time zone. |
text | RichText | Yes | The comment text; give the format with the text. |
author_name | string? | No | The name of the author when the author is not a user of the package and author_ref is left out. The comment is then shown with the system AI user as its author, and its text starts with a line "— <name>" holding this name. Ignored when author_ref is given. |
author_ref | Ref<users>? refers to Users | No | The user who created the record, by the external_id of a users record, for example u-ava. Leave it out or use null when the author is unknown or has left. |
emojis | object[] refers to Users | No | Reactions to the comment, one item per user and emoji, for example [{"emoji": "👍", "user_ref": "u-ava"}]. A user adds the same emoji to a comment once. Reactions to document comments are not supported.Constraints: items are unique. Default: |
emojis[].emoji | string | Yes | The reaction: one emoji as text, for example "👍" or "🎉". Most emojis fit, skin tones included; a combined emoji longer than 4 characters, such as a family emoji, is rejected.Constraints: 1–4 characters. |
emojis[].user_ref | Ref<users> refers to Users | Yes | The user who reacted, by the external_id of a users record.Constraints: 1–512 characters. |
parent_comment_ref | Ref<comments>? refers to Comments | No | The comment this one replies to; leave it out for a comment that starts a thread. It must be a comment of the same card. Rule: A comment of the same card. |
updated_at | Timestamp? | No | When the comment was last edited. Constraints: RFC 3339 with a time zone. |
References
Referenced by
- Attachments:
attached_to - Comments:
parent_comment_ref
Comments
Show on the entity map
Example
A record of this entity:
{
"external_id": "cm-1",
"card_ref": "k-mrr",
"author_ref": "u-liam",
"text": {
"format": "markdown",
"text": "Finance confirmed that annual plans are divided by twelve. Updated the definition."
},
"created_at": "2026-02-02T10:05:00Z",
"emojis": [
{
"emoji": "👍",
"user_ref": "u-ava"
},
{
"emoji": "🎉",
"user_ref": "u-noor"
}
]
}Rules
- parent_comment_ref builds a tree; no record can be its own ancestor.
Related entities
Activities, Attachments, Cards, Users
Check after the import
After the import, the records of this entity can be checked on Card comments › Retrieve card comments.
JSON Schema
comments.json
