Skip to main content
The ClickUp connector enables Omni to index and search content from your ClickUp workspaces, including tasks, comments, and documents.

​
Overview

​
What Gets Indexed

SourceContent
TasksTask title, description, status, priority, assignee, tags, and comments
DocsDocument title and content (optional — can be toggled on/off)

​
How It Works

  1. You create a ClickUp personal API token
  2. The connector syncs tasks across all workspaces
  3. Optionally enable document syncing
  4. Workspace and space-based permissions ensure appropriate access control
The connector uses read-only access. Omni cannot create, modify, or delete any content in your ClickUp workspace.

​
Prerequisites

Before setting up the ClickUp connector, ensure you have:
  • ClickUp account with permission to create API tokens
  • Omni deployment with the ClickUp connector service running

​
Setup

​
Step 1: Create a ClickUp API Token

  1. Go to ClickUp Settings > Apps
  2. Under API Token, click Generate
  3. Copy the generated token
Keep your API token secure. Anyone with access to this token can read tasks and documents from your ClickUp workspace.

​
Step 2: Connect in Omni

  1. Navigate to Settings → Integrations in Omni
  2. Find ClickUp and click Connect
  3. Enter your API token
  4. Optionally enable Include Docs to sync ClickUp documents alongside tasks
  5. Click Connect
  6. Click Sync Now to start the initial sync
Your ClickUp connector is now configured. Initial indexing may take a while depending on the number of tasks and documents in your workspaces.

​
Managing the Integration

​
Viewing Sync Status

Navigate to Settings → Integrations to view the sync status for each source directly on the list, including last sync time, number of indexed items, and any errors. Click Configure on a source for more details.

​
Sync Modes

The ClickUp connector supports two sync modes:
ModeDescription
FullSyncs all tasks and documents across workspaces (used for initial sync)
IncrementalSyncs only items modified since last sync (used for updates)
After the initial full sync, the connector automatically performs incremental syncs to capture new and updated tasks and documents.

​
Troubleshooting

The token may be expired or revoked.Solution:
  1. Go to ClickUp Settings > Apps
  2. Regenerate your API token
  3. Update the token in Omni via Settings → Integrations → ClickUp
  4. Restart the ClickUp connector service
ClickUp has API rate limits. The connector handles these automatically with exponential backoff.Solution: Wait for the connector to retry. For large workspaces, initial sync may take longer due to rate limits.
Document syncing is an optional feature that must be explicitly enabled.Solution: Ensure Include Docs is enabled during setup. You can update this setting in Settings → Integrations → ClickUp.

​
Security Considerations

  • Read-only access: The connector only reads tasks and documents
  • Workspace-based permissions: Access is scoped to workspace and private space membership
  • Token security: API tokens should be treated like passwords
  • Encrypted storage: Credentials are encrypted at rest in Omni

​
What’s Next

Search Your Data

Learn how to search across ClickUp tasks and documents

AI Assistant

Ask questions about your ClickUp tasks and projects

Add More Connectors

Connect additional data sources