Overview
What Gets Indexed
How It Works
- You create a ClickUp personal API token
- The connector syncs tasks across all workspaces
- Optionally enable document syncing
- 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
- Go to ClickUp Settings > Apps
- Under API Token, click Generate
- Copy the generated token
Step 2: Connect in Omni
- Navigate to Settings → Integrations in Omni
- Find ClickUp and click Connect
- Enter your API token
- Optionally enable Include Docs to sync ClickUp documents alongside tasks
- Click Connect
- Click Sync 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 Settings on a source for more details and sync history.Space Filters
By default, the connector indexes tasks and documents across all workspaces your API token can access. Use space filters in the source settings to limit task indexing to specific ClickUp spaces. ClickUp Docs are indexed with workspace-level permissions, so space filters do not limit their permissions.Sync Modes
The ClickUp connector supports two sync modes:
After the initial full sync, the connector automatically performs incremental syncs to capture new and updated tasks and documents. Sync checkpoints are persisted safely, so interrupted runs resume from where they left off.
MCP OAuth (Remote Tools)
The ClickUp connector can also serve as an MCP bridge, exposing ClickUp as a set of Omni agent tools for reading and writing tasks and documents. This requires per-user OAuth authorization:- Navigate to Settings → Integrations → ClickUp
- Under the MCP OAuth section, click Connect
- You’ll be guided through a ClickUp OAuth flow with PKCE — no admin-created OAuth app is needed
- Once connected, Omni gains access to ClickUp actions scoped to your OAuth grant
Troubleshooting
Tasks not appearing in search
Tasks not appearing in search
Common causes:
- Sync has not completed yet
- Your account does not have access to the workspace containing the tasks
API token validation failed
API token validation failed
The token may be expired or revoked.Solution:
- Go to ClickUp Settings > Apps
- Regenerate your API token
- Delete the existing ClickUp source in Omni and reconnect it with the new token
Rate limiting errors
Rate limiting errors
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.
Documents not being indexed
Documents not being indexed
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 and space permissions: Tasks retain private-space grouping when applicable; Docs use workspace-level permissions
- 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
Omni Agent
Ask questions about your ClickUp tasks and projects
Add More Connectors
Connect additional data sources