ClickUp Component
Use the ClickUp component to manage users, projects, and teams in your ClickUp workspace.
Component key: click-up
Description
ClickUp ClickUp is a CRM, collaboration, knowledge base, and project management tool.
Use the Clickup component to manage users, projects, and teams in your Clickup workspace.
Connections
ClickUp Personal Access Token
Personal API token Configuration Instructions
To make API requests to ClickUp using a personal API token you may generate one using the following Personal API token steps.
- Log into ClickUp.
- Click on your avatar in the lower-left corner and select Apps.
- Under API Token, click Generate.
- You can copy and paste your personal API token.
| Input | Notes | Example |
|---|---|---|
| Personal Access Token | Follow the next steps to get an API key https://help.clickup.com/hc/en-us/articles/6303426241687-Getting-Started-with-the-ClickUp-API#personal-api-key |
ClickUp OAuth 2.0
Oauth Configuration Instructions
To make API requests of Clickup on behalf of your customers you will need to create an "App" within Clickup. https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app
- Log into ClickUp.
- Click on your avatar in the lower-left corner and select Integrations.
- Click on ClickUp API.
- Click Create an App.
- Give your app a name and provide the redirect URL as
https://oauth2.prismatic.io/callback - Once your app is created, you'll be provided with a client ID and Secret that may be entered in the connection
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for Click Up | https://app.clickup.com/api |
| Client ID | Follow this step to generate https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app | |
| Client Secret | Follow this step to generate https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app | |
| Headers | Additional header to supply to authorization requests | |
| Scopes | ClickUp does not support granular scopes | |
| Token URL | The OAuth 2.0 Token URL for Click Up | https://api.clickup.com/api/v2/oauth/token |
Triggers
Webhook
Receive and validate webhook requests from ClickUp for webhooks you configure. | key: webhook
Data Sources
Calendar Views
A picklist of Calendar Views in a Space | key: calendars | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space ID |
Custom Field Options
A picklist of Options for a given Custom Field | key: customFieldOptions | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Field Name | Sales Stage | |
| List ID |
Custom Fields
A picklist of Custom Fields | key: customFields | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID |
Folders
A picklist of Folders in a Space | key: folders | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space ID |
Lists
A picklist of available Lists in a given Folder | key: lists | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Folder ID |
Spaces
A picklist of Spaces available in a Workspace | key: spaces | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID |
Tasks
A picklist of Tasks in a List | key: tasks | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID |
Teams Authorized Workspaces
A picklist of Workspaces available to the authenticated user | key: teams | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Actions
Add Guest to Folder
Share a Folder with a guest. | key: addGuestToFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Folder ID | Folder ID | |
| Guest ID | Guest ID | |
| Include Shared | Exclude details of items shared with the guest by setting this parameter to false | true |
| Permission Level | Can be read (view only), comment, edit, or create (full). | read |
Add Guest to List
Share a List with a guest. | key: addGuestToList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Guest ID | Guest ID | |
| Include Shared | Exclude details of items shared with the guest by setting this parameter to false | true |
| List ID | List ID | |
| Permission Level | Can be read (view only), comment, edit, or create (full). | read |
Add Guest to Task
Share a task with a guest. | key: addGuestToTask
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by its Custom Task ID, this value must be true. | true |
| Guest ID | Guest ID | |
| Include Shared | Exclude details of items shared with the guest by setting this parameter to false | true |
| Permission Level | Can be read (view only), comment, edit, or create (full). | read |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true | 9010065123 |
Add Task to List
Add a new task to an additional List. | key: addTaskToList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | List ID | |
| Task ID | Task ID |
Create Folder
Add a new Folder to a Space. | key: createFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Name | Folder Name | |
| Space ID | Space ID value. |
Create List
Add a new list to a folder. | key: createList
| Input | Notes | Example |
|---|---|---|
| Assignee | Include a user_id to assign this List. | |
| Connection | ||
| Content | Content | |
| Due Date | Initial due date of the new list | |
| Due Date Time | Due Date Time | false |
| Folder ID | Folder ID | |
| Name | Name of the new list | |
| Name | Name of the new list | |
| Priority | Initial priority of the new list | |
| Status | Status refers to the List color rather than the task Statuses available in the List. |
Create Space
Add a new Space to a Workspace. | key: createSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Enable Checklists | Enable Checklists? | true |
| Enable Custom Fields | Enable Custom Fields? | true |
| Enable Dependency Warning | Enable Dependency Warning? | true |
| Enable Due Dates | Enable Due Dates? | true |
| Enable Portfolios | Enable Portfolios? | true |
| Enable Remap Dependencies | Enable Remap Dependencies? | true |
| Enable Tags | Enable Tags? | true |
| Enable Time Estimates | Enable Time Estimates? | true |
| Enable Time Tracking | Enable Time Tracking? | true |
| Multiple Assignees | Will this Space have multiple assignees? | true |
| Remap closed Due Dates | Remap closed Due Dates? | false |
| Remap Due Dates | Remap Due Dates? | true |
| Space Name | Space Name | New space name |
| Team ID | Team ID (Workspace) value | 9010065123 |
| Use Start Date | Use Start Date? | true |
Create Task
Create a new Task | key: createTask
| Input | Notes | Example |
|---|---|---|
| Assignee | Task Assignees | |
| Check Required Custom Fields | When creating a task via API any required Custom Fields are ignored by default (false). | false |
| Connection | ||
| Custom Fields | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Description | Task Description | |
| Due Date | Task Due Date | 1508369194377 |
| Due Date Time | Task Due Date Time | false |
| Links To | Include a task ID to create a linked dependency with your new task. | |
| List ID | List ID | |
| Markdown Description | Markdown formatted description. | |
| Name | Task Name | |
| Notify All | If notify_all is true, notifications will be sent to everyone including the creator of the comment. | true |
| Parent | You can create a subtask by including an existing task ID. The parent task ID you include cannot be a subtask, and must be in the same List specified in the path parameter. | |
| Priority | Task Priority | |
| Start Date | Task Start Date | 1567780450202 |
| Start Date Time | Task Start Date Time | false |
| Status | Task Status | |
| Tag | Task Tags | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
| Time Estimate | Task Time Estimate | 8640000 |
Create Task Attachment
Upload a file to a task as an attachment. | key: createTaskAttachment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| File | File to attach. | |
| File Name | Name of the file to attach. | my-image.png |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
Create Task Comment
Add a new comment to a task. | key: createTaskComment
| Input | Notes | Example |
|---|---|---|
| Assignee | Assignee by ID | |
| Comment Text | Comment Text | |
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Notify All | If notify_all is true, notifications will be sent to everyone including the creator of the comment. | true |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
Create Team
This endpoint is used to create Teams: user groups which are groups of users you can assign items to in your Workspace. | key: createTeam
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Member | Add user by ID | 123456 |
| Name | Desired Team Name | New team name |
| Team ID | Team ID (Workspace) value | 9010065123 |
Create Time Entry
Create a time entry. | key: createTimeEntry
| Input | Notes | Example |
|---|---|---|
| Assignee | Workspace owners and admins can include unknown user id. Workspace members can only include their own user id. | |
| Include Subtasks | Billable | false |
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Custom Team ID | Only used when the custom_task_ids parameter is set to true. | |
| Description | Description | |
| Duration | Duration | |
| Start | Start time | |
| Tags | Code should have this format | |
| Task ID | Associate a time entry with a task by ID | |
| Team ID | Team ID (Workspace) value | 9010065123 |
Create Webhook
Create a new webhook for a specific List. | key: createWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Endpoint | URL of the webhook endpoint. | |
| Event | Event type to trigger the webhook. | taskCreated |
| Folder ID | Folder ID | |
| List ID | List ID | |
| Space ID | Space ID | |
| Task ID | Task ID | |
| Team ID | Team ID (Workspace) | 9010065123 |
Delete Comment
Delete a task comment. | key: deleteComment
| Input | Notes | Example |
|---|---|---|
| Comment ID | Comment ID | |
| Connection |
Delete Folder
Delete a Folder from your Workspace. | key: deleteFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Folder ID | Folder ID |
Delete List
Delete a List from your Workspace. | key: deleteList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | List ID |
Delete Space
Delete a Space from your Workspace. | key: deleteSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space ID | Space ID value. |
Delete Task
Delete a task from your Workspace. | key: deleteTask
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
Delete Team
This endpoint is used to remove a Team: user group from your Workspace. | key: deleteTeam
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Group ID | Team ID (user group). | 7C73-4002-A6A9-310014852858 |
Delete Time Entry
Delete a time entry from a Workspace. | key: deleteTimeEntry
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
| Timer ID | The ID of a time entry. |
Delete Webhook
Delete a webhook. | key: deleteWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Webhook ID | Webhook ID | e506-4a29-9d42-26e504e3435e (uuid) |
Edit Guest on Workspace
Rename and configure options for a guest. | key: editGuestOnWorkspace
| Input | Notes | Example |
|---|---|---|
| Can Create Views | true | |
| Can Edit Tags | true | |
| Can See Time Estimated | true | |
| Can See Time Spent | true | |
| Connection | ||
| Custom Role ID | Custom Role ID value | |
| Guest ID | Guest ID | |
| Team ID | Team ID (Workspace) value | 9010065123 |
| Username |
Edit User On Workspace
Update a user's name and role. | key: editUserOnWorkspace
| Input | Notes | Example |
|---|---|---|
| Admin | Make an admin? | true |
| Connection | ||
| Custom Role ID | Custom Role ID value | |
| Team ID | Team ID (Workspace) value | 9010065123 |
| User ID | User ID value | 38312345 |
Get Accessible Custom Fields
View the Custom Fields available on tasks in a specific List. | key: getAccessibleCustomFields
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | Only include time entries associated with tasks in a specific List. |
Get Authorized Teams (Workspaces)
View the Workspaces available to the authenticated user. | key: getAuthorizedTeams
| Input | Notes | Example |
|---|---|---|
| Connection |
Get Folder
View the Lists within a Folder. | key: getFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Folder ID | Folder ID |
Get Guest
View information about a guest in a Workspace. | key: getGuest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Guest ID | Guest ID | |
| Team ID | Team ID (Workspace) value | 9010065123 |
Get List
View details for a specific List. | key: getList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | List ID |
Get List Members
View the people who have access to a List. | key: getListMembers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | List ID |
Get Singular Time Entry
View a single time entry. | key: getSingularTimeEntry
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Include Location Names | Include the names of the List, Folder, and Space along with the list_id,folder_id, and space_id. | true |
| Include Task Tags | Include task tags in the response for time entries associated with tasks. | true |
| Team ID | Team ID (Workspace) value | 9010065123 |
| Timer ID | The ID of a time entry. |
Get Space
View the Spaces available in a Workspace by ID. | key: getSpace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Space ID | Space ID value. |
Get Task
View information about a task. | key: getTask
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Include Subtasks | Include or exclude subtasks. By default, subtasks are excluded. | false |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
Get Task Comments
View task comments. | key: getTaskComments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Start Date | Unix time in milliseconds | |
| Start ID | Enter the Comment id of a task comment. | |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
Get Task Members
View the members assigned to a task. | key: getTaskMembers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Task ID | Task ID |
Get Team
This endpoint is used to view Teams: user groups in your Workspace. | key: getTeam
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Group IDs | Enter one or more Team ids (user groups) to retrieve information about specific Teams. | C9C58BE9-7C73-4002-A6A9-310014852858 |
| Team ID | Team ID (Workspace) value | 9010065123 |
Get Time Entries Within a Date Range
View time entries filtered by start and end date. By default, this endpoint returns time entries from the last 30 days created by the authenticated user. | key: getTimeEntriesWithinDateRange
| Input | Notes | Example |
|---|---|---|
| Assignee | Filter by User ID | |
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Custom Team ID | Only used when the custom_task_ids parameter is set to true. | |
| End Date | Unix time in milliseconds | |
| Folder ID | Only include time entries associated with tasks in a specific Folder. | |
| Include Location Names | Include the names of the List, Folder, and Space along with the list_id,folder_id, and space_id. | true |
| Include Task Tags | Include task tags in the response for time entries associated with tasks. | true |
| List ID | Only include time entries associated with tasks in a specific List. | |
| Space ID | Only include time entries associated with tasks in a specific Space. | |
| Start Date | Unix time in milliseconds | |
| Task ID | Only include time entries associated with a specific task. | |
| Team ID | Team ID (Workspace) value | 9010065123 |
Get User
View information about a user in a Workspace. | key: getUser
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
| User ID | User ID value | 38312345 |
Get Webhooks
View all webhooks for a list. | key: getWebhooks
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
Get Workspace Plan
View the current Plan for the specified Workspace. | key: getWorkspacePlan
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
Get Workspace Seats
View the used, total, and available member and guest seats for a Workspace. | key: getWorkspaceSeats
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
Invite Guest to Workspace
Invite a new guest to a workspace. | key: inviteGuestToWorkspace
| Input | Notes | Example |
|---|---|---|
| Can Create Views | true | |
| Can Edit Tags | true | |
| Can See Time Estimated | true | |
| Can See Time Spent | true | |
| Connection | ||
| Custom Role ID | Custom Role ID value | |
Email address of the invited guest | example@email.com | |
| Team ID | Team ID (Workspace) value | 9010065123 |
Invite User To Workspace
Invite someone to join your Workspace as a member. | key: inviteUserToWorkspace
| Input | Notes | Example |
|---|---|---|
| Admin | Make an admin? | true |
| Connection | ||
| Custom Role ID | Custom Role ID value | |
Email address of User being added | example@email.com | |
| Team ID | Team ID (Workspace) value | 9010065123 |
List Folders
View all folders in a space. | key: listFolders
| Input | Notes | Example |
|---|---|---|
| Archived | Archived? | false |
| Connection | ||
| Space ID | Space ID value. |
List Lists
View the Lists within a Folder. | key: getLists
| Input | Notes | Example |
|---|---|---|
| Archived | Filter for archived Lists? | false |
| Connection | ||
| Folder ID | Folder ID |
List Spaces
View the Spaces available in a Workspace. | key: listSpaces
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
List Tasks
View the tasks in a List. | key: listTasks
| Input | Notes | Example |
|---|---|---|
| Archived | Archived? | false |
| Assignee | Filter by Assignees. Add Assingee | |
| Connection | ||
| Custom Fields | Code should have this format | |
| Date Created Greater Than | Filter by date created greater than Unix time in milliseconds. | |
| Date Created Less Than | Filter by date created less than Unix time in milliseconds. | |
| Date Done Greater Than | Filter by date done greater than Unix time in milliseconds. | |
| Date Done Less Than | Filter by date done less than Unix time in milliseconds. | |
| Date Updated Greater Than | Filter by date updated greater than Unix time in milliseconds. | |
| Date Updated Less Than | Filter by date updated less than Unix time in milliseconds. | |
| Due Date Greater Than | Filter by due date greater than Unix time in milliseconds. | |
| Due Date Less Than | Filter by due date less than Unix time in milliseconds. | |
| Include Closed | Include or excluse closed tasks. By default, they are excluded. | false |
| List ID | Team ID (Workspace) | |
| Order By | Order by a particular field. By default, tasks are ordered by created. | Options include: id, created, updated, and due_date. |
| Page | 0 | |
| Reverse | Tasks are displayed in reverse order. | false |
| Include Subtasks | Include or exclude subtasks. By default, subtasks are excluded. | false |
| Tag | Filter by tags. Add a tag to filter. |
Raw Request
Send raw HTTP request to ClickUp | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/space/${spaceId}/tag), The base URL is already included (https://api.clickup.com/api/v2). For example, to connect to https://api.clickup.com/api/v2/space/${spaceId}/tag, only /space/${spaceId}/tag is entered in this field. | /space/${spaceId}/tag |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Remove Custom Field Value
Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field. | key: removeCustomFieldValue
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by its Custom Task ID, this value must be true. | true |
| Field ID | Enter the universal unique identifier (UUID) of the Custom Field you want to set. | |
| Task ID | Enter the task ID of the task you want to update. | |
| Team ID | Only used when the custom_task_ids parameter is set to true | 9010065123 |
Remove Guest From Folder
Revoke a guest's access to a Folder. | key: removeGuestFromFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Folder ID | Folder ID | |
| Guest ID | Guest ID | |
| Include Shared | Exclude details of items shared with the guest by setting this parameter to false | true |
Remove Guest From List
Revoke a guest's access to a List. | key: removeGuestFromList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Guest ID | Guest ID | |
| Include Shared | Exclude details of items shared with the guest by setting this parameter to false | true |
| List ID | List ID |
Remove Guest From Task
Revoke a guest's access to a task. | key: removeGuestFromTask
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Task ID | If you want to reference a task by its Custom Task ID, this value must be true. | true |
| Guest ID | Guest ID | |
| Include Shared | Exclude details of items shared with the guest by setting this parameter to false | true |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true | 9010065123 |
Remove Guest From Workspace
Revoke a guest's access to a Workspace. | key: removeGuestFromWorkspace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Guest ID | Guest ID | |
| Team ID | Team ID (Workspace) value | 9010065123 |
Remove Task From List
Remove a task from an additional List. You can't remove a task from its home List. | key: removeTaskFromList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | List ID | |
| Task ID | Task ID |
Remove User From Workspace
Deactivate a user from a Workspace. | key: removeUserFromWorkspace
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
| User ID | User ID value | 38312345 |
Set Custom Field Value
Update the value of a Custom Field on a task. | key: setCustomFieldValue
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Field ID | Enter the universal unique identifier (UUID) of the Custom Field you want to set. | |
| Field Value | ||
| Task ID | Enter the task ID of the task you want to update. | |
| Value Type |
Start a Time Entry
Start a timer for the authenticated user. | key: startTimeEntry
| Input | Notes | Example |
|---|---|---|
| Include Subtasks | Billable | false |
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Custom Team ID | Only used when the custom_task_ids parameter is set to true. | |
| Description | Description | |
| Tag name | Add a tag name | |
| Task ID | Associate a time entry with a task by ID | |
| Team ID | Team ID (Workspace) value | 9010065123 |
Stop a Time Entry
Stop a timer that's currently running for the authenticated user. | key: stopTimeEntry
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Team ID | Team ID (Workspace) value | 9010065123 |
Update Comment
Replace the content of a task comment, assign a comment, and mark a comment as resolved. | key: updateComment
| Input | Notes | Example |
|---|---|---|
| Assignee | Assignee by ID | |
| Comment ID | Comment ID | |
| Comment Text | Comment Text | |
| Connection | ||
| Resolved | Resolved? | false |
Update Folder
Rename a Folder | key: updateFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Folder ID | Folder ID | |
| Name | Folder Name |
Update List
Rename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color. | key: updateList
| Input | Notes | Example |
|---|---|---|
| Assignee | User ID of the list assignee | |
| Connection | ||
| Content | Content | |
| Due Date | Due date of the list | |
| Due Date Time | Set to true if due date has a time | false |
| List ID | List ID | |
| Name | Name of the list | |
| Priority | Priority of the list | |
| Status | Status refers to the List color rather than the task Statuses available in the List. | |
| Unset Status | By default, this is false. To remove the List color use unset_status: true. | false |
Update Space
Rename, set the Space color, and enable ClickApps for a Space. | key: updateSpace
| Input | Notes | Example |
|---|---|---|
| Admin Can Manage | Admin Can Manage? | true |
| Connection | ||
| Color | Hex Color Number | #7B68EE |
| Enable Checklists | Enable Checklists? | true |
| Enable Custom Fields | Enable Custom Fields? | true |
| Enable Dependency Warning | Enable Dependency Warning? | true |
| Enable Due Dates | Enable Due Dates? | true |
| Enable Portfolios | Enable Portfolios? | true |
| Enable Remap Dependencies | Enable Remap Dependencies? | true |
| Enable Tags | Enable Tags? | true |
| Enable Time Estimates | Enable Time Estimates? | true |
| Enable Time Tracking | Enable Time Tracking? | true |
| Multiple Assignees | Will this Space have multiple assignees? | true |
| Private | Private? | true |
| Remap closed Due Dates | Remap closed Due Dates? | false |
| Remap Due Dates | Remap Due Dates? | true |
| Space ID | Space ID value. | |
| Space Name | Space Name | New space name |
| Use Start Date | Use Start Date? | true |
Update Task
Update a task | key: updateTask
| Input | Notes | Example |
|---|---|---|
| Add Assignee | Add Assignee | |
| Archived | Include Archived? | false |
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Description | Task Description | |
| Due Date | Task Due Date | 1508369194377 |
| Due Date Time | Task Due Date Time | false |
| Markdown Description | Markdown formatted description. | |
| Name | Task Name | |
| Parent | You can move a subtask to another parent task by including "parent" with a valid task id. | |
| Priority | Task Priority | |
| Remove Assignee | Remove Assignee | |
| Start Date | Task Start Date | 1567780450202 |
| Start Date Time | Task Start Date Time | false |
| Status | Task Status | |
| Task ID | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
| Time Estimate | Task Time Estimate | 8640000 |
Update Team
This endpoint is used to manage Teams: user groups which are groups of users you can assign items to in your Workspace | key: updateTeam
| Input | Notes | Example |
|---|---|---|
| Add Member | Add members by ID. Comma separate each user ID. | 12345,5678 |
| Connection | ||
| Group ID | Team ID (user group). | 7C73-4002-A6A9-310014852858 |
| Remove Member | Remove members by ID. Comma separate each user ID. | 12345,5678 |
| Team Handle | You may update the team handle which is used to @mention a Team (user group) in your Workspace. | handle |
| Team Name | Desired Team Name | team name |
Update Time Entry
Update the details of a time entry. | key: updateTimeEntry
| Input | Notes | Example |
|---|---|---|
| Assignee | Workspace owners and admins can include unknown user id. Workspace members can only include their own user id. | |
| Include Subtasks | Billable | false |
| Connection | ||
| Custom Task ID | If you want to reference a task by it's custom task id, this value must be true. | false |
| Custom Team ID | Only used when the custom_task_ids parameter is set to true. | |
| Description | Description | |
| Duration | Duration | |
| End | End time | |
| Start | Start time | |
| Tag Action | Tag Action (use replace, add or remove) | replace, add or remove |
| Tags | Code should have this format | |
| Task ID | Associate a time entry with a task by ID | |
| Team ID | Team ID (Workspace) value | 9010065123 |
| Timer ID | The ID of a time entry. |
Update Webhook
Update the configuration of a webhook. | key: updateWebhook
| Input | Notes | Example |
|---|---|---|
| All Events | Subscribe to all events, when set to true it overrides the event inputs | false |
| Connection | ||
| Endpoint | URL of the webhook endpoint. | |
| Event | Event type to trigger the webhook. | taskCreated |
| Status | Status | |
| Webhook ID | Webhook ID | e506-4a29-9d42-26e504e3435e (uuid) |