Skip to content

ClickUp

This page describes how to configure the ClickUp connector as part of a data pipeline within Designer.

The ClickUp connector is a Flex connector. In the Data Productivity Cloud, Flex connectors let you connect to a curated set of endpoints to load data.

You can use the ClickUp connector in its preconfigured state, or you can edit the connector by adding or amending available ClickUp endpoints as per your use case. You can edit Flex connectors in the Custom Connector user interface.

For detailed information about authentication, specific endpoints parameters, pagination, and more aspects of the ClickUp API, read the ClickUp API documentation There are two versions of the ClickUp API, both of which you can access through the link provided.


Properties

Name = string

A human-readable name for the component.


Data Source = drop-down

The data source to load data from in this pipeline. The drop-down menu lists the ClickUp API endpoints available in the connector. For detailed information about specific endpoints, read the ClickUp API documentation.

Endpoint Method Reference
Get Authorized User GET View the details of the authenticated user's ClickUp account
Get Authorized Teams GET View the Workspaces available to the authenticated user
Get Task Comments GET View task comments
Get Chat View Comments GET View comments from a Chat view
Get List Comments GET View the comments added to a List
Get Threaded Comments GET View threaded comments
Get Custom Task Types GET View the custom task types available in a Workspace
Get Accessible Custom Fields GET View the custom fields available on tasks in a specific list
Search Docs GET View the docs in your Workspace
Get Doc PageListing GET View the PageListing for a doc
Get Doc Pages GET View pages belonging to a doc
Get Folders GET View the folders in a space
Get Goals GET View the goals available in a workspace
Get Lists GET View the lists within a folder
Get Folderless Lists GET View the lists in a space that aren't located in a folder
Get Task Members GET View the people who have access to a task
Get List Members GET View the people who have access to a list
Get Custom Roles GET View the custom roles available in a workspace
Shared Hierarchy GET View the tasks, lists, and folders that have been shared with the authenticated user
Get Spaces GET View the spaces available in a workspace
Get Space Tags GET View the task tags available in a space
Get Tasks GET View the tasks in a list
Get Filtered Team Tasks GET View the tasks that meet specific criteria from a workspace
Get Task Templates GET View the task templates available in a workspace
Get Workspace Seats GET View the used, total, and available member and guest seats for a workspace
Get Time Entries GET View time entries filtered by start and end date
Get Time Entry History GET View a list of changes made to a time entry
Get Running Time Entry GET View a time entry that's currently tracking time for the authenticated user
Get All Tags From Time Entries GET View all the labels that have been applied to time entries in a Workspace
Get User GET View information about a user in a Workspace
Get Workspace Views GET View the task and page views available at the Everything Level of a workspace
Get Space Views GET View the task and page views available for a space
Get Folder Views GET View the task and page views available for a folder
Get List Views GET View the task and page views available for a List
Get View Tasks GET See all visible tasks in a view in ClickUp
Get Webhooks GET View the webhooks created via the API for a Workspace

Authentication Type = drop-down

The authentication method to authorize access to your ClickUp data. Currently supports API Key.


Key = string

The key of a working API key:value pair.

You are required to authenticate through the header parameter Authorization. Enter "Authorization" in the Key field.


Value = drop-down

Use the drop-down menu to select the corresponding secret definition that denotes the value of a working API key:value pair.

Read Secret definitions to learn how to create a new secret definition.

Read the ClickUp API documentation to learn how to acquire an API key.


URI Parameters = column editor

  • Parameter Name: The name of a URI parameter.
  • Parameter Value: The value of the corresponding parameter.
Required parameter Endpoints Description
api_version Get Authorized User, Get Authorized Teams, Get Task Comments, Get Chat View Comments, Get List Comments, Get Custom Task Types, Get Accessible Custom Fields, Get Folders, Get Goals, Get Lists, Get Folderless Lists, Get Task Members, Get List Members, Get Custom Roles, Shared Hierarchy, Get Spaces, Get Time Entry History, Get Running Time Entry, Get All Tags From Time Entries, Get User, Get Workspace Views, Get Space Views, Get Folder Views, Get List Views, Get View Tasks, Get Webhooks v2
api_version Search Docs, Get Doc PageListing, Get Doc Pages v3
task_id Get Task Comments, Get Task Members The task ID.
view_id Get Chat View Comments, Get View Tasks The view ID.
list_id Get List Comments, Get Accessible Custom Fields, Get List Members, Get List Views The list ID. Read the list_id parameter description in Get Tasks for instructions on how to obtain the list_id.
comment_id Get Threaded Comments Your comment ID.
team_id Get Custom Task Types, Shared Hierarchy, Get Goals, Get Custom Roles, Get Spaces, Get Time Entry History, Get Running Time Entry, Get All Tags From Time Entries, Get User, Get Workspace Views, Get Webhooks The Team ID of the workspace.
workspaceId Search Docs, Get Doc PageListing, Get Doc Pages The ID of the workspace.
docId Get Doc PageListing, Get Doc Pages The ID of the doc.
space_id Get Folders, Get Folderless Lists, Get Space Views The ID of a space.
folder_id Get Lists, Get Folder Views The folder ID.
timer_id Get Time Entry History The ID of the timer.
user_id Get User The user ID in a workspace.

Query Parameters = column editor

  • Parameter Name: The name of a query parameter.
  • Parameter Value: The value of the corresponding parameter.
Required parameter Endpoints Description
page Get View Tasks 0

Header Parameters = column editor

  • Parameter Name: The name of a URI parameter.
  • Parameter Value: The value of the corresponding parameter.
Required parameter Endpoints Description
Content-Type All endpoints application/json

Post Body = JSON

A JSON body as part of a POST request.


Page Limit = integer

A numeric value to limit the maximum number of records per page.


Select your cloud data warehouse.

Destination = drop-down

  • Snowflake: Load your data into Snowflake. You'll need to set a cloud storage location for temporary staging of the data.
  • Cloud Storage: Load your data directly into your preferred cloud storage location.

Click either the Snowflake or Cloud Storage tab on this page for documentation applicable to that destination type.

Warehouse = drop-down

The Snowflake warehouse used to run the queries. The special value, [Environment Default], will use the warehouse defined in the environment. Read Overview of Warehouses to learn more.


Database = drop-down

The Snowflake database. The special value, [Environment Default], will use the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.


Schema = drop-down

The Snowflake schema. The special value, [Environment Default], will use the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.


Table Name = string

The name of the table to be created.


Load Strategy = drop-down

  • Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
  • Truncate and Insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
  • Fail if Exists: If the specified table name already exists, this pipeline will fail to run.

Clean Staged files = boolean

  • Yes: Staged files will be destroyed after data is loaded. This is the default setting.
  • No: Staged files are retained in the staging area after data is loaded.

Stage Platform = drop-down

Choose a data staging platform using the drop-down menu.

  • S3: Stage your data on an AWS S3 bucket.
  • Snowflake: Stage your data on a Snowflake internal stage.
  • Azure Storage: Stage your data in an Azure Blob Storage container.

Click one of the tabs below for documentation applicable to that staging platform.

Amazon S3 Bucket = drop-down

An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.

Internal Stage Type = drop-down

A Snowflake internal stage type. Currently, only type User is supported.

Read Choosing an Internal Stage for Local Files to learn more about internal stage types and the usage of each.

Storage Account = drop-down

Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.


Container = drop-down

Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.

Load Strategy = drop-down

  • Append Files in Folder: Appends files to storage folder. This is the default setting.
  • Overwrite Files in Folder: Overwrite existing files with matching structure.

See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:

Configuration Description
Append files in folder with defined folder path and file prefix. Files will be stored under the structure uniqueID/timestamp-partX where X is the part number, starting from 1. For example, 1da27ea6-f0fa-4d15-abdb-d4e990681839/20240229100736969-part1.
Append files in folder without defined folder path and file prefix. Files will be stored under the structure folder/prefix-timestamp-partX where X is the part number, starting from 1. For example, folder/prefix-20240229100736969-part1.
Overwrite files in folder with defined folder path and file prefix. Files will be stored under the structure folder/prefix-partX where X is the part number, starting from 1. All files with matching structures will be overwritten.
Overwrite files in folder without defined folder path and file prefix. Validation will fail. Folder path and file prefix must be supplied for this load strategy.

Folder Path = string

The folder path of the written files.


File Prefix = string

A string of characters to include at the beginning of the written files. Often used for organizing database objects.


Storage = drop-down

A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.

Click the tab that corresponds to your chosen cloud storage service.

Amazon S3 Bucket = drop-down

An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.

Storage Account = drop-down

Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.


Container = drop-down

Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.

GCS Bucket= drop-down

The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the cloud provider credentials that you have associated with your environment.

Destination = drop-down

  • Databricks: Load your data into Databricks. You'll need to set a cloud storage location for temporary staging of the data.
  • Cloud Storage: Load your data directly into your preferred cloud storage location.

Click either the Databricks or Cloud Storage tab on this page for documentation applicable to that destination type.

Catalog = drop-down

Select a Databricks Unity Catalog. The special value, [Environment Default], will use the catalog specified in the Data Productivity Cloud environment setup. Selecting a catalog will determine which schema are available in the next parameter.


Schema (Database) = drop-down

The Databricks schema. The special value, [Environment Default], will use the schema defined in the environment. Read Create and manage schemas to learn more.


Table Name = string

The name of the table to be created.


Load Strategy = drop-down

  • Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
  • Truncate and Insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
  • Fail if Exists: If the specified table name already exists, this pipeline will fail to run.

Clean Staged Files = boolean

  • Yes: Staged files will be destroyed after data is loaded. This is the default setting.
  • No: Staged files are retained in the staging area after data is loaded.

Stage Platform = drop-down

Choose a data staging platform using the drop-down menu.

  • S3: Stage your data on an AWS S3 bucket.
  • Azure Storage: Stage your data in an Azure Blob Storage container.

Click one of the tabs below for documentation applicable to that staging platform.

Amazon S3 Bucket = drop-down

An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.

Storage Account = drop-down

Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.


Container = drop-down

Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.

Load Strategy = drop-down

  • Append Files in Folder: Appends files to storage folder. This is the default setting.
  • Overwrite Files in Folder: Overwrite existing files with matching structure.

See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:

Configuration Description
Append files in folder with defined folder path and file prefix. Files will be stored under the structure uniqueID/timestamp-partX where X is the part number, starting from 1. For example, 1da27ea6-f0fa-4d15-abdb-d4e990681839/20240229100736969-part1.
Append files in folder without defined folder path and file prefix. Files will be stored under the structure folder/prefix-timestamp-partX where X is the part number, starting from 1. For example, folder/prefix-20240229100736969-part1.
Overwrite files in folder with defined folder path and file prefix. Files will be stored under the structure folder/prefix-partX where X is the part number, starting from 1. All files with matching structures will be overwritten.
Overwrite files in folder without defined folder path and file prefix. Validation will fail. Folder path and file prefix must be supplied for this load strategy.

Folder Path = string

The folder path of the written files.


File Prefix = string

A string of characters to include at the beginning of the written files. Often used for organizing database objects.


Storage = drop-down

A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.

Click the tab that corresponds to your chosen cloud storage service.

Amazon S3 Bucket = drop-down

An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.

Storage Account = drop-down

Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.


Container = drop-down

Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.

GCS Bucket= drop-down

The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the cloud provider credentials that you have associated with your environment.

Destination = drop-down

  • Amazon Redshift: Load your data into Amazon Redshift. You'll need to set a cloud storage location for temporary staging of the data.
  • Cloud Storage: Load your data directly into your preferred cloud storage location.

Click either the Amazon Redshift or Cloud Storage tab on this page for documentation applicable to that destination type.

Schema = drop-down

Select the Redshift schema. The special value, [Environment Default], will use the schema defined in the environment. For information about using multiple schemas, read Schemas.


Table Name = string

The name of the table to be created.


Load Strategy = drop-down

  • Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
  • Truncate and Insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
  • Fail if Exists: If the specified table name already exists, this pipeline will fail to run.

Clean Staged Files = boolean

  • Yes: Staged files will be destroyed after data is loaded. This is the default setting.
  • No: Staged files are retained in the staging area after data is loaded.

Amazon S3 Bucket = drop-down

An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.

Load Strategy = drop-down

  • Append Files in Folder: Appends files to storage folder. This is the default setting.
  • Overwrite Files in Folder: Overwrite existing files with matching structure.

See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:

Configuration Description
Append files in folder with defined folder path and file prefix. Files will be stored under the structure uniqueID/timestamp-partX where X is the part number, starting from 1. For example, 1da27ea6-f0fa-4d15-abdb-d4e990681839/20240229100736969-part1.
Append files in folder without defined folder path and file prefix. Files will be stored under the structure folder/prefix-timestamp-partX where X is the part number, starting from 1. For example, folder/prefix-20240229100736969-part1.
Overwrite files in folder with defined folder path and file prefix. Files will be stored under the structure folder/prefix-partX where X is the part number, starting from 1. All files with matching structures will be overwritten.
Overwrite files in folder without defined folder path and file prefix. Validation will fail. Folder path and file prefix must be supplied for this load strategy.

Folder Path = string

The folder path of the written files.


File Prefix = string

A string of characters to include at the beginning of the written files. Often used for organizing database objects.


Storage = drop-down

A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.

Click the tab that corresponds to your chosen cloud storage service.

Amazon S3 Bucket = drop-down

An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.

Storage Account = drop-down

Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.


Container = drop-down

Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.

GCS Bucket= drop-down

The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the cloud provider credentials that you have associated with your environment.


Log Level = drop-down

Set the severity level of logging. Choose from the following:

  • Error
  • Warn
  • Info
  • Debug
  • Trace

Deactivate soft delete for Azure blobs (Databricks)

If you intend to set your destination as Databricks and your stage platform as Azure Storage, you must turn off the "Enable soft delete for blobs" setting in your Azure account for your pipeline to run successfully. To do this:

  1. Log in to the Azure portal.
  2. In the top-left, click ☰ → Storage Accounts.
  3. Select the intended storage account.
  4. In the menu, under Data management, click Data protection.
  5. Untick Enable soft delete for blobs. For more information, read Soft delete for blobs.

Snowflake Databricks Amazon Redshift