Configure ClickUp as a Source in your Pipeline

Perform the following steps to configure your ClickUp Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select ClickUp.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. On the Select Pipeline Type page, click Edge, and then click Continue.

   

   This page appears only if the selected Destination type is supported in Edge and your team has an existing ClickUp Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.

6. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, ClickUp Source.

   • In the Connect to ClickUp section, specify the following:

     • API Key: The API Token that you obtained from your ClickUp account to allow Hevo to access your data.

7. Click Test & Continue to test the connection to your ClickUp Source.

   When you click this button, Hevo validates that the API Key field is not null or empty, then makes a request to the GET /user endpoint to retrieve the authenticated user’s profile. If the request confirms that the token is valid and has workspace access, the connection test is marked as successful. You can then proceed to set up your Destination.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Selecting a parent object automatically includes all its associated child objects for replication. Child objects cannot be selected or deselected individually.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests all available historical data for the selected objects and loads it into the Destination.

• Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.

For Task and Time Entry objects and their child objects, Hevo ingests only the incremental data in subsequent Pipeline runs. Incremental changes are detected using the date_updated and start_time timestamp fields, respectively.

For all other objects, Hevo ingests the entire data during each Pipeline run.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

Currently, ClickUp enforces API rate limits. If the rate limit is exceeded, a rate limit exception occurs. Hevo handles such scenarios using built-in retry logic, applicable to both historical and incremental ingestion. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

---

Data Model

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

---