.do
ApiCommunication

Comment

A user-generated comment or reply posted on content, items, or in discussions, with support for threading and reactions.

Comment

A user-generated comment or reply posted on content, items, or in discussions, with support for threading and reactions.

Properties

  • id (string): Unique identifier for the comment.
  • content (string): The text content of the comment.
  • html (string): HTML formatted version of the comment.
  • markdown (string): Markdown formatted version of the comment.
  • author ([[User]]): User who posted the comment.
  • parentType (string): Type of parent entity (post, issue, document, task).
  • parentId (string): ID of parent entity being commented on.
  • parentComment ([[Comment]]): Parent comment if this is a reply.
  • thread ([[Thread]]): Discussion thread this comment belongs to.
  • status (string): Comment status (published, pending, flagged, deleted).
  • visibility (string): Visibility level (public, private, internal).
  • mentions ([[Mention]][]): User mentions in the comment.
  • attachments ([[Attachment]][]): Files attached to the comment.
  • reactions ([[Reaction]][]): Emoji reactions to the comment.
  • replies ([[Comment]][]): Direct replies to this comment.
  • replyCount (number): Total number of replies.
  • isEdited (boolean): Whether the comment has been edited.
  • isPinned (boolean): Whether comment is pinned to top.
  • isResolved (boolean): Whether comment thread is resolved.
  • resolvedBy ([[User]]): User who resolved the comment.
  • resolvedAt (number): When comment was resolved (Unix timestamp).
  • editedAt (number): Timestamp when comment was edited (Unix timestamp).
  • postedAt (number): Timestamp when comment was posted (Unix timestamp).
  • created (number): Timestamp when the comment was created (Unix timestamp).
  • metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new comment.

Input: [[Comment]]
Output: [[Comment]]

update

Edit comment content.

Input: [[Comment]]
Output: [[Comment]]

delete

Permanently remove the comment.

Input: [[Comment]]
Output: [[Comment]]

reply

Create a reply to this comment.

Input: [[CommentReply]]
Output: [[Comment]]

edit

Edit the comment text.

Input: [[CommentEdit]]
Output: [[Comment]]

pin

Pin comment to top of discussion.

Input: [[Comment]]
Output: [[Comment]]

unpin

Unpin comment.

Input: [[Comment]]
Output: [[Comment]]

resolve

Mark comment thread as resolved.

Input: [[Comment]]
Output: [[Comment]]

unresolve

Reopen resolved comment thread.

Input: [[Comment]]
Output: [[Comment]]

flag

Flag comment for moderation.

Input: [[CommentFlag]]
Output: [[Comment]]

addReaction

Add emoji reaction to comment.

Input: [[Reaction]]
Output: [[Comment]]

removeReaction

Remove emoji reaction from comment.

Input: [[Reaction]]
Output: [[Comment]]

Events

  • created: Triggered when a new comment is posted.
  • updated: Triggered when comment is edited.
  • deleted: Triggered when a comment is deleted.
  • posted: Triggered when comment is published.
  • edited: Triggered when comment content is modified.
  • pinned: Triggered when comment is pinned.
  • unpinned: Triggered when comment is unpinned.
  • resolved: Triggered when comment thread is resolved.
  • unresolved: Triggered when resolved comment is reopened.
  • flagged: Triggered when comment is flagged.
  • Reaction.added: Triggered when a reaction is added.
  • Reaction.removed: Triggered when a reaction is removed.
  • Reply.posted: Triggered when a reply is added.