Skip to main content

ClickUp Component

ClickUp

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.

  1. Log into ClickUp.
  2. Click on your avatar in the lower-left corner and select Apps.
  3. Under API Token, click Generate.
  4. You can copy and paste your personal API token.

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

  1. Log into ClickUp.
  2. Click on your avatar in the lower-left corner and select Integrations.
  3. Click on ClickUp API.
  4. Click Create an App.
  5. Give your app a name and provide the redirect URL ashttps://oauth2.prismatic.io/callback
  6. Once your app is created, you'll be provided with a client ID and Secret that may be entered in the connection configuration page of Prismatic

Triggers​

Webhook​

Receive and validate webhook requests from ClickUp for webhooks you configure. | key: webhook

Output Example Payload​

{
  "payload": {
    "headers": {
      "content-type": "application/json",
      "Host": "hooks.prismatic.io",
      "User-Agent": "Amazon CloudFront",
      "X-Amz-Cf-Id": "Rac2uF9zf4sP-YoeH6Kw-hDwC2_Gv85W8C1234erwnvP7w9Svi1-1w==",
      "X-Amzn-Trace-Id": "Root=1-6488ce8f-1f6fe8a9778e3019463c9038",
      "x-b3-parentspanid": "25dad6fe551084df",
      "x-b3-sampled": "0",
      "x-b3-spanid": "229e0462ba367dd5",
      "x-b3-traceid": "79aa6cbfbd57277e",
      "x-datadog-parent-id": "2494436065687272917",
      "x-datadog-sampling-priority": "-1",
      "x-datadog-trace-id": "8766939195401250686",
      "x-signature": "5163a9e3d476388b9e3bb0263881234425660f948bba8bff9b32a2ae882bf1be"
    },
    "queryParameters": null,
    "rawBody": "<data (N bytes)>",
    "body": {
      "data": {
        "event": "taskCreated",
        "history_items": [
          {
            "id": "3538167764785216452",
            "type": 1,
            "date": "1686687372646",
            "field": "status",
            "parent_id": "901234567891",
            "data": {
              "status_type": "open"
            },
            "source": null,
            "user": {
              "id": 38312345,
              "username": "Uername",
              "email": "user@mail.com",
              "color": "#4169e1",
              "initials": "UN",
              "profilePicture": null
            },
            "before": {
              "status": null,
              "color": "#000000",
              "type": "removed",
              "orderindex": -1
            },
            "after": {
              "status": "to do",
              "color": "#a09d9d",
              "orderindex": 0,
              "type": "open"
            }
          },
          {
            "id": "3538167768123456789",
            "type": 1,
            "date": "1686687372646",
            "field": "task_creation",
            "parent_id": "901234567891",
            "data": {
              "via": "user",
              "trace_id": "7436346685143012345",
              "subcategory_id": "901001112345"
            },
            "source": "user",
            "user": {
              "id": 38312345,
              "username": "Uername",
              "email": "user@mail.com",
              "color": "#4169e1",
              "initials": "UN",
              "profilePicture": null
            },
            "before": null,
            "after": null
          }
        ],
        "task_id": "8684ud1r5",
        "webhook_id": "67d99bf6-0fb8-4db4-a4e1-a0e759573240"
      },
      "contentType": "application/json"
    },
    "pathFragment": "",
    "webhookUrls": {
      "flow2": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
      "Flow 1": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
      "webhook": "https://hooks.prismatic.io/trigger/WEBHOOK_ID"
    },
    "webhookApiKeys": {
      "flow2": ["sample-api-key"],
      "Flow 1": ["sample-api-key"],
      "webhook": ["sample-api-key"]
    },
    "invokeUrl": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
    "executionId": "EXECUTION_ID",
    "customer": {
      "id": "testCustomerId",
      "name": "Test Customer",
      "externalId": "testCustomerExternalId"
    },
    "instance": {
      "id": "testInstanceId",
      "name": "Test Instance"
    },
    "user": {
      "id": "testUserId",
      "email": "testUserEmail@example.com",
      "name": "Test User",
      "externalId": "testUserExternalId"
    }
  }
}

Data Sources​

Custom Field Options​

A picklist of Options for a given Custom Field | key: customFieldOptions | type: picklist

Custom Fields​

A picklist of Custom Fields | key: customFields | type: picklist

Folders​

A picklist of Folders in a Space | key: folders | type: picklist

Lists​

A picklist of available Lists in a given Folder | key: lists | type: picklist

Spaces​

A picklist of Spaces available in a Workspace | key: spaces | type: picklist

Teams Authorized Workspaces​

A picklist of Workspaces available to the authenticated user | key: teams | type: picklist

Actions​

Add Guest to Folder​

Share a Folder with a guest. | key: addGuestToFolder

Add Guest to List​

Share a List with a guest. | key: addGuestToList

Add Guest to Task​

Share a task with a guest. | key: addGuestToTask

Add Task to List​

Add a new task to an additional List. | key: addTaskToList

Create Folder​

Add a new Folder to a Space. | key: createFolder

Create List​

Add a new list to a folder. | key: createList

Create Space​

Add a new Space to a Workspace. | key: createSpace

Create Task​

Create a new Task | key: createTask

Create Task Attachment​

Upload a file to a task as an attachment. | key: createTaskAttachment

Create Task Comment​

Add a new comment to a task. | key: createTaskComment

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

Create Time Entry​

Create a time entry. | key: createTimeEntry

Create Webhook​

Create a new webhook for a specific List. | key: createWebhook

Delete Comment​

Delete a task comment. | key: deleteComment

Delete Folder​

Delete a Folder from your Workspace. | key: deleteFolder

Delete List​

Delete a List from your Workspace. | key: deleteList

Delete Space​

Delete a Space from your Workspace. | key: deleteSpace

Delete Task​

Delete a task from your Workspace. | key: deleteTask

Delete Team​

This endpoint is used to remove a Team: user group from your Workspace. | key: deleteTeam

Delete Time Entry​

Delete a time entry from a Workspace. | key: deleteTimeEntry

Delete Webhook​

Delete a webhook. | key: deleteWebhook

Edit Guest on Workspace​

Rename and configure options for a guest. | key: editGuestOnWorkspace

Edit User On Workspace​

Update a user's name and role. | key: editUserOnWorkspace

Get Accessible Custom Fields​

View the Custom Fields available on tasks in a specific List. | key: getAccessibleCustomFields

Get Authorized Teams (Workspaces)​

View the Workspaces available to the authenticated user. | key: getAuthorizedTeams

Get Folder​

View the Lists within a Folder. | key: getFolder

Get Guest​

View information about a guest in a Workspace. | key: getGuest

Get List​

View details for a specific List. | key: getList

Get List Members​

View the people who have access to a List. | key: getListMembers

Get Singular Time Entry​

View a single time entry. | key: getSingularTimeEntry

Get Space​

View the Spaces available in a Workspace by ID. | key: getSpace

Get Task​

View information about a task. | key: getTask

Get Task Comments​

View task comments. | key: getTaskComments

Get Task Members​

View the members assigned to a task. | key: getTaskMembers

Get Team​

This endpoint is used to view Teams: user groups in your Workspace. | key: getTeam

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

Get User​

View information about a user in a Workspace. | key: getUser

Get Webhooks​

View all webhooks for a list. | key: getWebhooks

Get Workspace Plan​

View the current Plan for the specified Workspace. | key: getWorkspacePlan

Get Workspace Seats​

View the used, total, and available member and guest seats for a Workspace. | key: getWorkspaceSeats

Invite Guest to Workspace​

Invite a new guest to a workspace. | key: inviteGuestToWorkspace

Invite User To Workspace​

Invite someone to join your Workspace as a member. | key: inviteUserToWorkspace

List Folders​

View all folders in a space. | key: listFolders

List Lists​

View the Lists within a Folder. | key: getLists

List Spaces​

View the Spaces available in a Workspace. | key: listSpaces

List Tasks​

View the tasks in a List. | key: listTasks

Raw Request​

Send raw HTTP request to ClickUp | key: rawRequest

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

Remove Guest From Folder​

Revoke a guest's access to a Folder. | key: removeGuestFromFolder

Remove Guest From List​

Revoke a guest's access to a List. | key: removeGuestFromList

Remove Guest From Task​

Revoke a guest's access to a task. | key: removeGuestFromTask

Remove Guest From Workspace​

Revoke a guest's access to a Workspace. | key: removeGuestFromWorkspace

Remove Task From List​

Remove a task from an additional List. You can't remove a task from its home List. | key: removeTaskFromList

Remove User From Workspace​

Deactivate a user from a Workspace. | key: removeUserFromWorkspace

Set Custom Field Value​

Update the value of a Custom Field on a task. | key: setCustomFieldValue

Start a Time Entry​

Start a timer for the authenticated user. | key: startTimeEntry

Stop a Time Entry​

Stop a timer that's currently running for the authenticated user. | key: stopTimeEntry

Update Comment​

Replace the content of a task comment, assign a comment, and mark a comment as resolved. | key: updateComment

Update Folder​

Rename a Folder | key: updateFolder

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

Update Space​

Rename, set the Space color, and enable ClickApps for a Space. | key: updateSpace

Update Task​

Update a task | key: updateTask

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

Update Time Entry​

Update the details of a time entry. | key: updateTimeEntry

Update Webhook​

Update the configuration of a webhook. | key: updateWebhook