Configuration guide

ClickUp

'Access tasks from ClickUp'

Before you begin

Availability depends on your school's enabled tools, provider setup, and account permissions. These settings are managed in the web workspace. A class policy may restrict a feature described here.

How it works#

The ClickUp connector will pull in all tasks from the ClickUp workspace, or specific space(s), list(s), folder(s) specified by the user.

Tasks are updated every 10 minutes.

Understanding ClickUp Hierarchy#

In ClickUp, there are multiple containers which contain task(s). These could be -

Entire Workspace
Spaces
Folders
Lists

Detailed information on the hierarchy of above mentioned objects is available here

Setting up#

Authorization#

Log in to ClickUp#

Log into ClickUp.

Open Apps settings#

In ClickUp 2.0, click your avatar in the lower-left corner and select Apps. In ClickUp 3.0, click your avatar in the upper-right corner, select Settings, and scroll down to click Apps in the sidebar.

Generate API token#

Under API Token, click Generate. A Personal API token will be generated and displayed!

Indexing#

Open ClickUp connector#

Navigate to the Admin Panel and select the ClickUp Connector

Enter API token and Team ID#

In Step 1, provide your API Token and the Team ID from above.

Select connector type#

Select the type of connector you want to pull in tasks from.

Notes

This could be Entire Workspace, Space(s), List(s), or Folder(s).
To pull tasks from entire workspace, just select Entire Workspace from the dropdown, and do not add any ID(s).
To pull tasks from specific space(s), folder(s), or lists(s), select the respective option from the dropdown, and add the ID(s) below. At least one ID needs to be added in this case.
The space id(s), folder id(s), list id(s) could be found in the web url in Clickup. For example, if you open a list in the ClickUp UI, you will see the list id in the url address bar as follows -

Enter IDs as needed#

If any of the Space(s), List(s), or Folder(s) connector type is selected, add one or more respective IDs to index the tasks from.

Choose comment indexing#

Check Retrieve Task Comments? to also retrieve and index all comments for each indexed task. Leave this unchecked if you don't want to index task comments.

Start indexing#

Click Connect to begin indexing.

Before using this source with students#

Start with approved course material. Check which documents the connector can retrieve and how it maps source permissions. Test with a student account and a teacher account before widening access. A successful sync does not prove that the intended class boundary is correct.

Use source troubleshooting when a document is missing or visible to the wrong audience.