🔐 Plus Plugin Only: This is only available in the Plus version of the plugin. Get the Plus plugin here.

Fields

The following fields are available in this action:

FieldTypeDescription
Room IDTextThe ID of the room
Thread IDTextThe ID of the thread
Comment IDTextThe ID of the comment.

Returned Values

The following values are returned by the action: [] indicates an array of objects.

KeyTypeDescription
body.typeTextThe type of the created object, typically "comment".
body.threadIdTextThe unique identifier for the thread to which the comment belongs.
body.roomIdTextThe unique identifier for the room where the comment was created.
body.idTextThe unique identifier for the created comment.
body.userIdTextThe user ID of the person who created the comment.
body.createdAtDate/TimeThe timestamp of when the comment was created.
body.bodyObjectThe content body of the comment. This is an object that includes version and content.
body.body.versionNumberThe version number of the comment content.
body.body.contentArrayAn array of content blocks in the comment. Each block contains further nested data, such as paragraph text.
body.body.content[].typeTextThe type of the content block (e.g., "paragraph").
body.body.content[].childrenArrayAn array containing the children of the content block. Typically contains text objects for each paragraph.
body.body.content[].children[].textTextThe actual text content of the comment, such as "hi".
error.status_codeNumberThe HTTP status code returned by the API (e.g., 200 for success).
error.status_messageTextThe HTTP status message returned by the API (e.g., "OK").
error.bodyTextThe raw error body message as a string.
returned_an_errorBooleanA flag indicating whether the API returned an error. false means no error occurred.