🔐 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 where the thread will be created.
User IDTextThe unique identifier of the user creating the thread.
TextTextThe comment content to be added to the thread.

Returned Values

The following values are returned by the action:

Returned Values

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

KeyTypeDescription
body.typeTextThe type of the created object, typically "thread".
body.idTextThe unique identifier for the created thread.
body.roomIdTextThe unique identifier for the room where the thread was created.
body.commentsArrayAn array of comments associated with the thread.
body.comments[].typeTextThe type of the object, typically "comment".
body.comments[].threadIdTextThe unique identifier for the thread that the comment belongs to.
body.comments[].roomIdTextThe unique identifier for the room where the comment was created.
body.comments[].idTextThe unique identifier for the comment within the thread.
body.comments[].userIdTextThe user ID of the person who created the comment.
body.comments[].createdAtDate/TimeThe timestamp of when the comment was created.
body.comments[].bodyObjectThe content body of the comment. This is an object that includes version and content.
body.comments[].body.versionNumberThe version number of the comment content.
body.comments[].body.contentArrayAn array of content blocks in the comment. Each block contains further nested data, such as paragraph text.
body.comments[].body.content[].typeTextThe type of the content block (e.g., "paragraph").
body.comments[].body.content[].childrenArrayAn array containing the children of the content block. Typically contains text objects for each paragraph.
body.comments[].body.content[].children[].textTextThe actual text content of the comment, such as "Hey there".
body.createdAtDate/TimeThe timestamp of when the thread was created.
body.updatedAtDate/TimeThe timestamp of when the thread was last updated.
body.resolvedBooleanA flag indicating whether the thread has been resolved.
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.