ClickUp Custom icon

ClickUp Custom

Consume ClickUp Custom API
Join our community

Actions2

Overview

This n8n node allows you to set custom fields on a specific ClickUp task. It is designed for scenarios where you need to update or add custom field values (such as text, dropdowns, or labels) to existing tasks in your ClickUp workspace. This is particularly useful for automating workflows that require dynamic updates to task metadata, such as syncing information from other systems, updating statuses, or tagging tasks based on external triggers.

Practical examples:

  • Automatically update a "Status" custom field when a related event occurs in another system.
  • Set a "Customer Name" or "Order ID" custom field on tasks created from e-commerce orders.
  • Tag tasks with campaign names or priorities based on incoming data.

Properties

Name Type Meaning
Authentication options Select the authentication method: Access Token or OAuth2. Determines which credentials are used for API access.
Team Name or ID options The ClickUp team to operate within. Can be selected from a list or specified by ID/expression. Required for context.
Space Name or ID options The ClickUp space within the selected team. Can be selected from a list or specified by ID/expression. Required for context.
List Name or ID options The ClickUp list containing the target task. Can be selected from a list or specified by ID/expression. Required for context.
Task ID string The unique identifier of the task to which custom fields will be added or updated.
Custom Fields collection Collection of custom fields to set. Supports both text and option-based custom fields. At least one custom field must be provided.
└ Custom Fields Text fixedCollection (multi) For text-type custom fields. Each entry requires a Field Name or ID and a Field Value (string).
└ Custom Fields Options fixedCollection (multi) For dropdown/label custom fields. Each entry requires a Field Name or ID and a Field Value (option).
Additional Fields collection Optional additional settings.
└ Use Date Time On Custom Fields boolean If enabled, sets the custom field value as a date-time object (where applicable).

Output

The node returns a JSON object with the following structure:

{
  "message": "OK",
  "responseData": [
    {
      // Response(s) from ClickUp API for each custom field set operation.
      // Structure depends on the ClickUp API response for setting a custom field.
    }
  ]
}
  • message: Always "OK" if successful.
  • responseData: An array containing the API responses for each custom field that was set. The exact structure of each item depends on the type of custom field and ClickUp's API response.

If an error occurs and "Continue On Fail" is enabled, the output will include an error property with the error message.

Dependencies

  • External Service: Requires access to the ClickUp API.
  • Authentication: Needs either a ClickUp Access Token or OAuth2 credentials configured in n8n.
  • n8n Configuration: Credentials for ClickUp must be set up in n8n under the appropriate authentication method.

Troubleshooting

Common Issues:

  • Missing Required Fields: If no custom fields are provided, the node throws an error:
    "Minimum 1 Custom Fields to Setting"
    • Resolution: Ensure at least one custom field is specified in the input.
  • Invalid IDs: Providing incorrect Team, Space, List, or Task IDs will result in API errors.
    • Resolution: Double-check that all IDs are correct and exist in your ClickUp workspace.
  • Authentication Errors: Invalid or missing credentials will prevent API calls.
    • Resolution: Verify that the correct credentials are selected and have sufficient permissions.

Error Handling:

  • If "Continue On Fail" is enabled, errors are returned in the output with an error property and an empty json object.

Links and References

Discussion