ClickUp
Create and manage tasks, lists, and comments in ClickUp.
On this page
- Connect
- Call it from a workflow
- Actions (31)
- create_task
- update_task
- create_channel
- create_channel_in_space_folder_list
- create_folderless_list
- create_message
- create_message_reaction
- create_message_reply
- create_subtask
- create_task_comments
- create_task_from_template
- custom_api_call
- delete_message
- delete_message_reaction
- delete_task
- get_accessible_custom_fields
- get_channel
- get_channel_messages
- get_channels
- get_list
- get_list_task
- get_message_reactions
- get_message_replies
- get_space
- get_spaces
- get_task_by_name
- get_task_comments
- list_workspace_tasks
- list_workspace_time_entries
- set_custom_fields_value
- update_message
- Details
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("clickup", "create_task", {
"workspace_id": "<workspace_id>",
"space_id": "<space_id>",
"list_id": "<list_id>",
"name": "<name>",
"custom_fields": {}
});
if (!res.success) throw new Error(res.error);
ctx.log.info("ClickUp answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "clickup-create-task",
name: "ClickUp: Create Task",
description: "Calls ClickUp when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("clickup", {
"action": "create_task",
"workspace_id": "<workspace_id>",
"space_id": "<space_id>",
"list_id": "<list_id>",
"name": "<name>",
"custom_fields": {}
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/clickup/create_task" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"workspace_id":"<workspace_id>","space_id":"<space_id>","list_id":"<list_id>","name":"<name>","custom_fields":{}}}'Actions
create_taskin catalog
Create Task. Create a new task in a ClickUp workspace and list
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
namerequired | text | The name of task |
status_idoptional | id (picked from your account) | The ID of Clickup Issue Status |
priority_idoptional | one of "1" | "2" | "3" | "4" | The ID of Clickup Issue Priority |
assignee_idoptional | ids (picked from your account) | ID of assignee for Clickup Task |
descriptionoptional | long text | The description of task |
is_markdownoptional | boolean | Is the description in markdown format |
due_dateoptional | date-time (ISO) | The due date of the task |
due_date_timeoptional | boolean | Whether to include time in the due date |
start_dateoptional | date-time (ISO) | The start date of the task |
start_date_timeoptional | boolean | Whether to include time in the start date |
time_estimateoptional | number | The time estimate for the task in milliseconds |
check_required_custom_fieldsoptional | boolean | Re-enable required custom fields validation for the task |
custom_fieldsrequired | object (depends on other props) | Custom Fields |
update_taskin catalog
Update Task. Update task in a ClickUp workspace and list
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_idrequired | id (picked from your account) | The ID of the ClickUp task |
nameoptional | text | The name of the task to update |
descriptionoptional | long text | The description of the task to update |
status_idoptional | id (picked from your account) | The ID of Clickup Issue Status |
priority_idoptional | one of "1" | "2" | "3" | "4" | The ID of Clickup Issue Priority |
add_assigneeoptional | ids (picked from your account) | assignee(s) you want to add for the task |
rem_assigneeoptional | ids (picked from your account) | assignee(s) you want to remove from the task |
create_channel
Create Channel. Creates a channel in a ClickUp workspace
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
namerequired | text | Name of the channel |
descriptionoptional | text | Description of the channel |
topicoptional | text | Topic of the channel |
visibilityrequired | one of "PUBLIC" | "PRIVATE" | Visibility of the channel |
create_channel_in_space_folder_list
Create Channel in Space/Folder/List. Creates a channel in a ClickUp workspace in a space, folder or list
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
descriptionoptional | text | Description of the channel |
topicoptional | text | Topic of the channel |
locationTyperequired | one of "folder" | "space" | "list" | Type of location |
locationIdrequired | text | ID of the location |
visibilityrequired | one of "PUBLIC" | "PRIVATE" | Visibility of the channel |
create_folderless_list
Create Folderless List. Create a new folderless list in a ClickUp workspace and space
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
namerequired | text | The name of the list to create |
create_message
Create Message. Creates a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
channel_idoptional | id (picked from your account) | The ID of Clickup Channel |
contentrequired | long text | Content of the message |
typerequired | one of "message" | "post" | Type of the message |
create_message_reaction
Create Message Reaction. Creates a reaction to a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to create reaction for |
emojirequired | text | Emoji to react with |
create_message_reply
Create Message Reply. Creates a reply to a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to reply to |
contentrequired | long text | Content of the message |
typerequired | one of "message" | "post" | Type of the message |
create_subtask
Create Subtask. Creates a subtask in ClickUp
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_idrequired | id (picked from your account) | The ID of the ClickUp task |
namerequired | text | The name of the subtask to create |
status_idoptional | id (picked from your account) | The ID of Clickup Issue Status |
priority_idoptional | one of "1" | "2" | "3" | "4" | The ID of Clickup Issue Priority |
assignee_idoptional | ids (picked from your account) | ID of assignee for Clickup Subtask |
descriptionoptional | long text | The description of the subtask to create |
is_markdownoptional | boolean | Is the description in markdown format |
due_dateoptional | date-time (ISO) | The due date of the subtask |
due_date_timeoptional | boolean | Whether to include time in the due date |
start_dateoptional | date-time (ISO) | The start date of the subtask |
start_date_timeoptional | boolean | Whether to include time in the start date |
time_estimateoptional | number | The time estimate for the subtask in milliseconds |
check_required_custom_fieldsoptional | boolean | Re-enable required custom fields validation for the subtask |
custom_fieldsrequired | object (depends on other props) | Custom Fields |
create_task_comments
Create Task Comment. Creates a comment on a task in ClickUp
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_idrequired | id (picked from your account) | The ID of the ClickUp task |
commentrequired | long text | Comment to make on the task |
assignee_idoptional | id (picked from your account) | ID of assignee for Task Comment |
create_task_from_template
Create Task From Template. Create a new task from Template
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
template_idrequired | id (picked from your account) | The ID of Clickup Task Template |
namerequired | text | The name of the task to create |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
delete_message
Delete Message. Deletes a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to delete |
delete_message_reaction
Delete Message Reaction. Deletes a reaction from a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to delete reaction from |
reaction_idrequired | text | ID of the reaction to delete |
delete_task
Delete Task. Delete a task in a workspace and list
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_idrequired | id (picked from your account) | The ID of the ClickUp task |
get_accessible_custom_fields
Get Accessible Custom Fields. View the Custom Fields available on tasks in a specific List.
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
get_channel
Get Channel. Gets a channel in a ClickUp workspace
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
channel_idoptional | id (picked from your account) | The ID of Clickup Channel |
get_channel_messages
Get Channel Messages. Gets all messages in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
channel_idoptional | id (picked from your account) | The ID of Clickup Channel |
limitoptional | number | Limit the number of messages returned |
content_formatoptional | one of "text/md" | "text/plain" | Format the content of the messages |
get_channels
Get Channels. Gets all channels in a ClickUp workspace
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
include_hiddenoptional | boolean | Include hidden channels |
limitoptional | number | Limit the number of channels returned |
get_list
Get List. Gets a list in a ClickUp
| Input | Type | Description |
|---|---|---|
list_idrequired | text | The id of the list to get |
get_list_task
Get Task. Gets a task in a ClickUp list
| Input | Type | Description |
|---|---|---|
task_idrequired | text | The ID of the task to get |
include_subtasksoptional | boolean | Include subtasks in the response |
get_message_reactions
Get Message Reactions. Gets the reactions of a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to get reactions for |
get_message_replies
Get Message Replies. Gets the replies of a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to get replies for |
get_space
Get Space. Gets a space in a ClickUp
| Input | Type | Description |
|---|---|---|
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
get_spaces
Get Spaces. Gets spaces in a ClickUp workspace
| Input | Type | Description |
|---|---|---|
team_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
get_task_by_name
Get Task by Name. Fetches a task by name in a ClickUp list
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_namerequired | text | The name of the task to find |
get_task_comments
Get Task Comments. Gets comments from a task in ClickUp
| Input | Type | Description |
|---|---|---|
task_idrequired | text | The ID of the task to get |
list_workspace_tasks
List Team Tasks. Retrieves the tasks that meet specific criteria from a Workspace.
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idoptional | ids (picked from your account) | The ID of the ClickUp space to create the task in |
folder_idoptional | ids (picked from your account) | The ID of the ClickUp folder |
list_idoptional | ids (picked from your account) | The ID of the ClickUp space to create the task in |
assigneesoptional | ids (picked from your account) | ID of assignee for Clickup Task |
tagsoptional | ids (picked from your account) | The tags to filter for |
pageoptional | number | Page to fetch (starts at 0). |
reverseoptional | boolean | Tasks are displayed in reverse order. |
include_closedoptional | boolean | Include or exclude closed tasks. By default, they are excluded. |
order_byoptional | one of "id" | "created" | "updated" | "due_date" | Order by a particular field. By default, tasks are ordered by created. |
list_workspace_time_entries
List Time Entries. Retrieves time entries filtered by start and end date.
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
start_dateoptional | date-time (ISO) | Start date |
end_dateoptional | date-time (ISO) | End date |
space_idoptional | id (picked from your account) | The ID of the ClickUp space to create the task in |
folder_idoptional | id (picked from your account) | The ID of the ClickUp folder |
list_idoptional | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_idoptional | id (picked from your account) | The ID of the ClickUp task |
assigneeoptional | ids (picked from your account) | ID of assignee for Clickup Task |
include_task_tagsoptional | boolean | Include task tags in the response for time entries associated with tasks. |
include_location_namesoptional | boolean | Include the names of the List, Folder, and Space along with the list_id, folder_id, and space_id. |
set_custom_fields_value
Set Custom Field Value. Add data to a Custom field on a task.
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
space_idrequired | id (picked from your account) | The ID of the ClickUp space to create the task in |
list_idoptional | id (picked from your account) | The ID of the ClickUp space to create the task in |
task_idrequired | id (picked from your account) | The ID of the ClickUp task |
field_idrequired | id (picked from your account) | The ID of the ClickUp custom field |
valuerequired | long text | The new value to be set |
update_message
Update Message. Updates a message in a ClickUp channel
| Input | Type | Description |
|---|---|---|
workspace_idrequired | id (picked from your account) | The ID of the ClickUp workspace |
message_idrequired | text | ID of the message to update |
contentrequired | long text | Content of the message |
content_formatrequired | one of "text/md" | "text/plain" | Format of the message content |
Details
- Id
clickup- Category
- Productivity
- Tags
- project-management, tasks, collaboration
- Package
@activepieces/piece-clickup@0.7.4- Tier
- Built in