ClickUp

Last updated on Jun 05, 2023

ClickUp is a SaaS-based project management and collaboration tool that allows businesses to manage their projects. You can use this tool for communication, collaboration, task assignments and statuses, alerts, and detail progress towards completion. You can customize alert and create custom workflows for your projects according to your requirements.

Hevo uses the ClickUP API to ingest data from your ClickUp account and load it to the desired Destination for scalable analysis.

Setup

Data Sync

Prerequisites

An active ClickUp account from which data is to be ingested.
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
The Workspace ID and API Token are available to authenticate Hevo on your ClickUp account.
You must be an Admin user or Account Owner to access all the data.

Obtaining the Workspace ID and API Token

ClickUp authenticates requests from Hevo to access the information about your users and accounts with your Workspace ID and API token.

Obtaining the Workspace ID

Perform the following steps to obtain your workspace ID:

Log in to your ClickUp account, and click Home.
Copy the workspace ID from the URL path of the ClickUp home page and save it in a secure location like any other password. For example, if the URL path is https://app.clickup.com/12345678/home, the workspace ID is 12345678.

Obtaining the API Token

Perform the following steps to find your API Key:

Log in to your ClickUp account.
In the bottom left corner, click on your username icon, and select Apps.
In the page that is displayed, under the API Token section, click Generate.
Copy the API token and save it in a secure location like any other password.

You have successfully obtained your workspace ID and API token. Copy and use them in Hevo to configure ClickUp as a Source.

Configuring ClickUp as a Source

Perform the following steps to configure ClickUp as the Source in your Pipeline:

Click PIPELINES in the Navigation Bar.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select ClickUp.
In the Configure your ClickUp Source page, specify the following:
- Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
- API Token: The API token that you generated in your ClickUp account to allow Hevo to access your data.
- Workspace ID: The ID of the workspace from which data is to be ingested.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Default Pipeline Frequency	Minimum Pipeline Frequency	Maximum Pipeline Frequency	Custom Frequency Range (Hrs)
1 hr	1 hr	24 hrs	1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

Historical Data: In the first run of the Pipeline, Hevo ingests all historical data for all the objects and loads it to the Destination.
Incremental Data: Once the historical load is complete, all new and updated records for the Tasks object is synchronized with your Destination according to the ingestion frequency.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Note: The Teams objects is available only for the paid users of ClickUp.

Object	Mode	Description
Spaces	Full Load	Contains the list of all the groups created in the ClickUp workspace within the organization, to organize the teams and projects. For example, a Marketing space used by the marketing team to manage all their projects.
Goals	Full Load	Contains the details of the objectives broken down into smaller, measurable targets that have to be completed to accomplish the goal.
Teams	Full Load	Contains the details of all the user groups in a workspace.
Tasks	Incremental	Contains the details of all the tasks assigned to users.
Time Entries	Full Load	Contains the details of the time tracked by users for a particular task.
Folders	Full Load	Contains the details about the folders that contain tasks categorized into different groups (lists) related to projects.
Lists	Full Load	Contains the details of all the various task groups in a folder.
Folderless Lists	Full Load	Contains the details of the groups of tasks which are not inside a folder.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Source Considerations

Rate Limit: ClickUp imposes a limit on the number of API calls within a specific time interval per token. These rate limits are based on your ClickUp Workspace plan. Read Rate Limits to know more about rate limits in ClickUp.

Limitations

Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Nov-23-2022	2.02	New document.