ClickUp destination

ClickUp is a productivity tool that lets you set up project workflows and tasks, and enable smooth cross-team collaboration.

RudderStack supports ClickUp as a destination where you can seamlessly send your event data.

Find the open source transformer code for this destination in the GitHub repository.

Getting started

Before configuring ClickUp as a destination in RudderStack, verify if the source platform is supported by ClickUp by referring to the table below:

To learn more about the difference between cloud mode and device mode in RudderStack, refer to the RudderStack Connection Modes guide.

Once you have confirmed that the source platform supports sending events to ClickUp, follow these steps:

1. From your RudderStack dashboard, add a source. Then, from the list of destinations, select ClickUp.
2. Assign a name to the destination and click Continue.

Connection settings

To successfully configure ClickUp as a destination, you will need to configure the following settings:

• API Token: Enter your ClickUp API token.
• List ID: Enter your ClickUp list ID.

For more information on obtaining your ClickUp API token and list ID, refer to the FAQ section below.

• Mapping to add custom fields while creating a task: Use this setting to map a specific RudderStack event property to a ClickUp Custom Field.

For more information on using this setting, refer to the Adding custom fields section below.

You can provide multiple ClickUp custom fields associated with different lists. However, note that the custom field name must be unique within a list to successfully create a task.

• Client-side Events Filtering: This setting lets you specify which events should be allowed to flow through to ClickUp.

RudderStack will discard the events not included in the allowlist.

Track

You can use the track calls to create a task in ClickUp.

A sample track call is shown below:

rudderanalytics.track(
  "Product Viewed", {
    "taskName": "Whole Foods Market",
    "tags": ["plan", "proposal", "marketing"],
    "timeEstimate": 10800000,
    "status": "Proposal",
    "dueDate": "2023-02-25T13:39:21.032Z",
    "startDate": "2022-01-20T13:39:21.032Z",
    "industryKey": "Retail",
    "paymentStatus": "Reject",
    "label": ["Transformer", "QA", "Testing"],
    "location": {
      "lat": -28.016667,
      "lng": 124,
      "formattedAddress": "New Orleans, Louisiana",
    },
    "phone": "+12025550146",
  }, {
    "externalId": [{
        "type": "clickUpListId",
        "id": "199314977",
      },
      {
        "type": "clickUpAssigneeId",
        "id": 61205104,
      },
      {
        "type": "clickUpAssigneeId",
        "id": 61229682,
      },
    ],
  }
);

RudderStack uses the ClickUp task endpoint to create a task within a list.

To successfully create a task, you need to specify the List ID in the dashboard settings. You can also pass the list ID through externalId, as seen in the above sample snippet.

RudderStack gives preference to the list ID passed via externalId over the list ID specified in the dashboard.

Adding assignees to a task

While creating a task, you can assign it to a Team(Workspace) member by specifying a userId. You can also pass multiple userId in an externalId array:

{
  "context": {
    "externalId": [{
        "type": "clickUpAssigneeId",
        "id": 1232
      },
      {
        "type": "clickUpAssigneeId",
        "id": 88765
      }
    ]
  }
}

Adding custom fields

You can pass the custom fields to ClickUp by specifying the mapping in the Mapping to add custom fields while creating a task dashboard setting:

You can specify the ClickUp Custom Field Name corresponding to the custom field you created in the ClickUp dashboard and the RudderStack Payload Property corresponding to the event property present in the payload.

RudderStack uses the custom field name to retrieve the id using the field endpoint.

Supported custom fields

RudderStack supports specifying the following ClickUp custom fields in the dashboard settings:

For more information on the above-mentioned fields, refer to the the ClickUp Custom Fields API reference.

RudderStack currently does not support specifying the following custom fields:

• Tasks
• Users
• Automatic Progress
• Manual Progress

Note that when sending the custom fields to ClickUp:

• You can provide multiple custom fields of different ClickUp lists in the dashboard.
• To successfully create a task, you need to provide a unique custom field name within a list in the custom field mapping.

Supported mapping

The following table lists the mappings between the optional RudderStack properties and the ClickUp properties:

Rate limits

Note that the ClickUp enforces rate limits per OAuth and personal token. This rate limit depends on your ClickUp plan and is summarized in the following table:

For more information, refer to the ClickUp Pricing page.

FAQ

Where can I find the ClickUp API Token?

To obtain your ClickUp API token, follow these steps:

1. Log into your ClickUp dashboard.
2. From the left sidebar, click the Settings button at the bottom and go to MY APPS > Apps.
3. You can find the API token listed here:

Where can I find the ClickUp List ID?

To get your ClickUp list ID, follow these steps:

1. In your ClickUp dashboard, click the ellipsis button next to your list and select Copy Link.

2. Paste the URL in your browser’s URL bar. You can find the list ID in the URL as highlighted in the below image:

How can I create custom fields in ClickUp?

To create custom fields in your ClickUp list, follow these steps:

1. In your ClickUp dashboard, click the ellipsis button next to your list and go to List settings > Custom Fields.

2. Choose the type of custom field you want to create and configure the Field Name and Field Type accordingly.

3. Finally, click Create.

Questions? Contact us by email or on Slack