ClickUp Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a ClickUp location.

ClickUp

Create a ClickUp Destination

1. Click the + icon on the Nexset that will be sent to the ClickUp destination, and select the Send to Destination option from the menu.

2. Select the ClickUp connector from the list of available destination connectors. Then, select the credential that will be used to connect to the ClickUp Workspace, and click Next; or, create a new ClickUp credential for use in this flow.

3. In Nexla, ClickUp destinations can be created using pre-built endpoint templates, which expedite destination setup for common ClickUp endpoints. Each template is designed specifically for the corresponding ClickUp endpoint, making destination configuration easy and efficient.
   • To configure this destination using a template, follow the instructions in Configure Using a Template.

   ClickUp destinations can also be configured manually, allowing you to send data to ClickUp endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ClickUp endpoints. Each template is designed specifically for the corresponding ClickUp endpoint, making destination setup easy and efficient.

ClickUp write operations target a specific location in the Workspace hierarchy (a List, Task, or Workspace), so most destination templates require an ID identifying where the data should be written. You can obtain these IDs by configuring a ClickUp data source with the corresponding listing endpoint (for example, run Get Lists to find a List ID or Get Tasks to find a Task ID).

• To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

  Create Task

  This endpoint creates a new Task in a specified List. The task name, description, status, assignees, priority, due date, and custom fields are taken from each record in the Nexset.

  • Enter the identifier of the List in which Tasks will be created in the List ID field. You can obtain List IDs from a ClickUp data source configured with the Get Lists endpoint.
  • Ensure each record in the Nexset includes at least a name field, which is required by ClickUp to create a task.

  This endpoint sends a POST request to /api/v2/list/{list_id}/task with each record as the JSON body. For the full list of supported task fields, refer to the Create Task reference.

  Update Task

  This endpoint updates an existing Task, supporting changes to status, assignees, due date, priority, description, and custom fields.

  • Enter the identifier of the Task to update in the Task ID field. Task IDs are returned by the Get Tasks and Get Filtered Team Tasks source endpoints.
  • Include only the fields you want to change in each Nexset record; ClickUp updates only the fields present in the request body.

  This endpoint sends a PUT request to /api/v2/task/{task_id} with each record as the JSON body. For details, refer to the Update Task reference.

  Delete Task

  This endpoint permanently deletes a Task by its ID. Use it to remove tasks from ClickUp based on records in the Nexset.

  • Enter the identifier of the Task to delete in the Task ID field. Task IDs are returned by the Get Tasks and Get Filtered Team Tasks source endpoints.

  This endpoint sends a DELETE request to /api/v2/task/{task_id}. Deletion is permanent and cannot be undone, so verify your Task IDs before activating the destination. For details, refer to the Delete Task reference.

  Create Task Comment

  This endpoint adds a new comment to a specific Task. Use it to post automated updates or notes onto tasks.

  • Enter the identifier of the Task to comment on in the Task ID field. Task IDs are returned by the Get Tasks and Get Filtered Team Tasks source endpoints.
  • Ensure each record includes a comment_text field containing the body of the comment.

  This endpoint sends a POST request to /api/v2/task/{task_id}/comment with each record as the JSON body. For details, refer to the Create Task Comment reference.

  Create Time Entry

  This endpoint records a new time-tracking entry within a Workspace, optionally associated with a Task. Use it to push logged time from external systems into ClickUp.

  • Enter the Workspace identifier in the Team ID field. You can obtain this value from a ClickUp data source configured with the Get Team endpoint.
  • Include the time-entry details (such as start, duration, and the associated tid task ID) in each Nexset record.

  This endpoint sends a POST request to /api/v2/team/{team_id}/time_entries with each record as the JSON body. For details, refer to the Create a Time Entry reference.

  Update Time Entry

  This endpoint updates an existing time-tracking entry—for example, to correct a duration or change the task it is associated with.

  • Enter the Workspace identifier in the Team ID field, and the identifier of the time entry to update in the Timer ID field.
  • Include only the time-entry fields you want to change in each Nexset record.

  This endpoint sends a PUT request to /api/v2/team/{team_id}/time_entries/{timer_id} with each record as the JSON body. For details, refer to the Update a Time Entry reference.

  Create List

  This endpoint creates a new List inside a specified Folder. Use it to provision Lists programmatically from your Nexset data.

  • Enter the identifier of the Folder in which Lists will be created in the Folder ID field. You can obtain Folder IDs from a ClickUp data source configured with the Get Folders endpoint.
  • Ensure each record includes a name field for the List to be created.

  This endpoint sends a POST request to /api/v2/folder/{folder_id}/list with each record as the JSON body. For details, refer to the Create List reference.

  Set Custom Field Value

  This endpoint sets or updates the value of a custom field on a specific Task. Use it to populate custom data on tasks from external systems.

  • Enter the identifier of the Task to update in the Task ID field, and the identifier of the custom field to set in the Field ID field. Field IDs are returned by the Get List Custom Fields and Get Team Custom Fields source endpoints.
  • Ensure each record includes a value field formatted according to the custom field's type.

  This endpoint sends a POST request to /api/v2/task/{task_id}/field/{field_id} with each record as the JSON body. For details, refer to the Set Custom Field Value reference.

  Create Webhook

  This endpoint registers a new webhook subscription so that an external endpoint receives real-time ClickUp events such as task creation or status changes.

  • Enter the Workspace identifier in the Team ID field. You can obtain this value from a ClickUp data source configured with the Get Team endpoint.
  • Include the webhook configuration (such as the endpoint URL and the list of events to subscribe to) in each Nexset record.

  This endpoint sends a POST request to /api/v2/team/{team_id}/webhook with each record as the JSON body. For details, refer to the Create Webhook reference.

Configure Manually

ClickUp destinations can be manually configured to send data to any valid ClickUp API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the ClickUp API after each call to a new Nexla webhook data source, which is useful for capturing the IDs that ClickUp returns when creating tasks, lists, or comments.

API Method

1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the ClickUp API from the Method pulldown menu. ClickUp write endpoints use POST to create resources, PUT to update them, and DELETE to remove them.

Data Format

3. Select the format in which the Nexset data will be sent to the ClickUp API from the Content Format pulldown menu. ClickUp expects application/json, so select the JSON format. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL

4. Enter the URL of the ClickUp API endpoint to which you want to send the Nexset data in the URL field. For update or delete operations, include the ID of the object to be modified at the end of the URL—for example, https://api.clickup.com/api/v2/task/{task_id} to update a specific Task.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

  You do not need to include any headers already present in the credentials. The Authorization header containing your ClickUp personal API token is applied automatically by Nexla.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this ClickUp destination, select the attributes from the Exclude Attributes pulldown menu. This is useful for stripping out internal fields that are not part of the ClickUp API request body.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

ClickUp's task, comment, and time-entry write endpoints operate on a single resource per request, so records are typically sent individually. Record batching is available for advanced scenarios where multiple records should be combined into a single request body.

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

   Property Inside JSON Object

   1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
   2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

   Code

   1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook

Optional

Nexla can automatically send the response received from the ClickUp API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and capture data returned by ClickUp, such as the ID of a newly created task or list.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the ClickUp API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the ClickUp API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the ClickUp API using the current settings.

   Test data is written to ClickUp

   Sending a test payload makes a live API call to your ClickUp Workspace. For create, update, or delete endpoints, this will modify real ClickUp data. Use a test List or Workspace when validating destination configuration.

Save & Activate the Destination

• Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to ClickUp, open the destination resource menu, and select Activate.

  The Nexset data will not be sent to ClickUp until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.