Tasks
Tasks represent the smallest unit of work in awork. They are used to break down larger chunks of work, track progress, and collaborate with others.
Types of Tasks
There are two types of tasks: project tasks and private tasks. This is identified by the baseType
field in the task object, which can be either projecttask
or private
.
Project tasks are tasks that are associated with a project and organized in task lists.
Private tasks are tasks that are associated with a user and are not visible to other users.
Creating a Task
The following properties are required when creating a task:
Subtasks
Subtasks have almost the same properties as tasks, but they also have a parentId
property that references the parent task. This is how you can create a subtask:
Learn more about subtasks here.
Checklist Items
Each task comes with a checklist of simple items that can be checked off. This is how you can create a checklist item:
Learn more about checklists here.
Task Lists
Tasks can be in one or several task lists. This is how you can add a task to a task list or change the list:
Task Comments
Task comments allow for discussions and communication about tasks. You can add comments to a task using the following endpoint:
Mentioning Users in Comments
You can mention users in comments by using a special syntax with the user’s Id. When a user is mentioned, they will receive a notification based on their notification settings.
The syntax for mentioning a user is: ~[userId:{userId}]
where {userId}
is the Id of the user you want to mention.
Notifying Task or Project Watchers
In addition to mentioning specific users, you can notify all users watching a task or project:
You can use:
~[task]
to notify all users watching the task~[project]
to notify all users watching the project the task belongs to~[workspace]
to notify all users in the workspace