ClickUp Connector

The ClickUp connector enables integration between ClickUp and Xurrent iPaaS, allowing you to manage ClickUp tasks, comments, attachments, and workspace structure, as well as trigger workflows based on ClickUp events.

Prerequisites

To use this connector, you need:

• A ClickUp account with access to the Workspace you want to integrate.
• A ClickUp API token or OAuth2 access token.
• Access to the required ClickUp Workspace.
• Xurrent iPaaS access with permission to create and configure connections.

Authentication Setups

The ClickUp connector supports authentication using a ClickUp API token or an OAuth2 access token.

API Token

You can use a ClickUp personal API token generated from ClickUp.

Personal API tokens start with pk_.

The token can be generated in ClickUp under:

Settings → Apps → API Token

When a personal API token is provided, the connector sends it using:

Authorization: <token>

OAuth2 Access Token

The connector also supports an OAuth2 access token.

OAuth2 tokens are sent using:

Authorization: Bearer <token>

The connector automatically detects whether the provided token is a personal API token or an OAuth2 access token.

Tokens are stored securely and encrypted. The token is not displayed after the connection has been saved.

Step 1: Generate ClickUp API Token

If you are using a personal API token:

1. Log in to ClickUp.
2. Open Settings.
3. Navigate to Apps.
4. Locate the API Token section.
5. Generate or copy your API token.
6. Keep the token available for configuring the Xurrent iPaaS connection.

Step 2: Configure the ClickUp Connection

In Xurrent iPaaS:

1. Create a new connection and select ClickUp.
2. Enter the API Token or OAuth2 access token.
3. Save the connection.
4. After saving the token, select the Workspace from the available list.
5. The connector retrieves the available Workspaces using the configured token.
6. Select the Workspace that you want to use for the integration.

The selected Workspace is associated with the connection and is used by all actions and triggers configured with that connection.

If you need to integrate with another ClickUp Workspace, create a separate ClickUp connection for that Workspace.

Available Actions

The ClickUp connector provides actions for tasks, comments, attachments, and ClickUp workspace structure.

Task Actions

• Create Task – Creates a new task in ClickUp.
• Get Task – Retrieves an existing ClickUp task.
• Update Task – Updates an existing task.
• Delete Task – Deletes a ClickUp task.
• Update Task Status – Updates the status of a ClickUp task.
• Assign User To Task – Assigns a ClickUp user to a task.

Comment Actions

• Create Task Comment – Creates a comment on a ClickUp task.
• Get Task Comments – Retrieves comments associated with a ClickUp task.

Attachment Actions

• Upload Task Attachment – Uploads an attachment to a ClickUp task.
• Get Task Attachments – Retrieves attachments associated with a ClickUp task.

Structure Actions

• Create List – Creates a List in ClickUp.
• Create Folderless List – Creates a List that is not associated with a Folder.
• Create Folder – Creates a Folder in ClickUp.

Lookup Actions

The connector also provides read actions that can be used to retrieve ClickUp IDs and other information at runtime:

• Get Authorized User
• Get Workspaces
• Get Spaces
• Get Folders
• Get Lists
• Get Folderless Lists
• Get List Members
• Get Workspace Members

These lookup actions are useful when IDs need to be retrieved dynamically instead of being hard-coded.

Available Trigger

ClickUp Event

The ClickUp Event trigger starts an Xurrent iPaaS workflow when a selected ClickUp webhook event occurs.

The trigger supports task, list, folder, space, goal, and key-result events.

You can select one or more supported ClickUp webhook events when configuring the trigger.

When multiple events are selected, the trigger provides an event output field identifying the event that caused the workflow to start.

The webhook is registered against the Workspace configured in the ClickUp connection.

ClickUp signs webhook deliveries, and the connector verifies the webhook signature before processing the event.

Event Filtering

The trigger supports optional filters to control which ClickUp events start the workflow.

Available filtering includes:

• Location – Filter events by List, Folder, or Space.
• Status – Filter status-related events.
• Assignee – Filter assignee-related events.

The status and assignee filters apply to the corresponding event types, while other selected event types are delivered without those filters.

For busy ClickUp Workspaces, use location filters where possible to limit unnecessary webhook deliveries.

Step 3: Configure the ClickUp Event Trigger

To configure the trigger:

1. Create or open an Xurrent iPaaS Runbook.
2. Add the ClickUp Event trigger.
3. Select the ClickUp connection.
4. Select the ClickUp webhook events that should start the workflow.
5. Optionally select a Space, Folder, or List to restrict the event location.
6. Configure status or assignee filters where applicable.
7. Save the trigger configuration.
8. Promote the Runbook when it is ready to process ClickUp events.

When an event is received, the workflow starts automatically after the webhook delivery has been validated.

Best Practices

• Select only the ClickUp events required by your workflow.
• When selecting multiple events, use the event output to determine which event triggered the workflow.
• Use a separate Runbook when different ClickUp events require substantially different processing.
• Select Space, Folder, and List values using the available dropdowns instead of hard-coding IDs.
• Use location filters for busy Workspaces to reduce unnecessary webhook deliveries.
• When using status or assignee filters, select the corresponding event type rather than applying the filter to a broad collection of unrelated events.
• Create separate connections when integrating with multiple ClickUp Workspaces.

Rate Limiting and Error Handling

ClickUp API rate limits depend on the ClickUp plan and authentication configuration.

For most plans, ClickUp allows approximately 100 requests per minute per token. Higher limits may apply to Business Plus and Enterprise plans.

The connector provides automatic handling for ClickUp rate-limit responses:

• Detects HTTP 429 rate-limit responses.
• Uses the Retry-After response header when provided by ClickUp.
• Waits for the specified number of seconds before retrying.
• When Retry-After is not provided, the connector waits 60 seconds before retrying.

For high-volume workflows, design the Runbook to avoid unnecessary API requests and use the available lookup and filtering capabilities efficiently.

Common Use Cases

• Create a ClickUp task when a Xurrent request is submitted.
• Update a ClickUp task when a Xurrent request changes.
• Post Xurrent updates as ClickUp task comments.
• Start a Xurrent workflow when a ClickUp task changes status.
• Assign ClickUp tasks to users based on Xurrent data.
• Synchronize attachments between Xurrent and ClickUp.
• Create ClickUp Lists or Folders as part of an automated provisioning workflow.
• Synchronize task information between Xurrent and ClickUp.

References

• ClickUp API Reference: https://developer.clickup.com/reference
• ClickUp Webhooks: https://developer.clickup.com/docs/webhooks
• ClickUp Webhook Signature: https://developer.clickup.com/docs/webhooksignature

‍