Comments

Create task comment

Changed on

Add a comment to a task. Mentions in the content notify the mentioned users, and the assignee is notified too. Returns the stored activity row, which carries no author object -- read the list route for that.

post/comment/{taskId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/comment/{taskId}
  • Auth
    HTTP bearer

Path parameters

taskIdstring required

Request body

contentstring required
externalUserNamestring

Attribution for an imported comment. Requires workspace:manage_settings and externalSource; otherwise ignored.

externalSource'planka' | 'trello' | 'jira' | 'plane' | 'linear' | 'kaneo'

The tool the comment was imported from. Supplying external attribution requires workspace:manage_settings.

Response

The created comment

idstring required
taskIdstring required
typestring required

One of: comment, task, create, status_changed, priority_changed, assignee_changed, unassigned, due_date_changed, title_changed, description_changed.

createdAtstring date-time required
updatedAtstring date-time required
userIdstring nullable required
contentstring nullable required
eventDataunknown
externalUserNamestring nullable required

Set when the activity was imported from another tool.

externalUserAvatarstring nullable required
externalSourcestring nullable required

The tool it was imported from: planka, trello, jira, plane, linear, kaneo, or a connected forge such as github.

externalUrlstring nullable required

Changes

  • 269feaac2cc4Revision changes
    • info

      added the new kaneo enum value to the request property

    • info

      added the new linear enum value to the request property

    • info

      added the new plane enum value to the request property

  • 4cb086e51a1aRevision changes
    • breaking

      removed the enum value kaneo of the request property

    • breaking

      removed the enum value linear of the request property

    • breaking

      removed the enum value plane of the request property