ClickUp Integration Documentation

What the Integration Does

ClickUp integration allows users to manage tasks, lists, and spaces within their ClickUp workspace programmatically. This includes creating, updating, deleting tasks, and listing tasks, lists, and spaces.

Short Description

The integration primarily focuses on task management, including the capability to list, create, retrieve, update, and delete tasks within specified spaces and lists. It's highly beneficial for project management and team collaboration to maintain organized workflows.

Example Scenarios

  • Automatically create tasks when certain criteria are met.
  • Retrieve and display a list of all tasks within a given space for team meetings.
  • Update tasks based on dynamic input from a third-party application.
  • Delete tasks that are obsolete or completed automatically.

Capabilities (Features)

  1. List Tasks - Retrieve all tasks within a specified space.
  2. Create Task - Add a new task to a specific list within a space.
  3. Get Task - Retrieve detailed information about a specific task by ID.
  4. Update Task - Modify details of a specified task.
  5. Delete Task - Remove a specific task from a list.
  6. List Spaces - List all spaces in the ClickUp workspace.
  7. List Lists - List all lists within a specified space.

Inputs/Outputs Schemas

List Tasks

  • Input: space_name (str): Name of the space to list tasks from
  • Output: JSON string containing details of tasks

Create Task

  • Input: space_name (str): Name of the space task_name (str): Name of the task task_description (str): Description of the task
  • Output: JSON string with created task details

Get Task

  • Input: task_id (str): ID of the task
  • Output: JSON string with task details

Update Task

  • Input: task_id (str): ID of the task, kwargs: Fields to update
  • Output: JSON string with updated task details

Delete Task

  • Input: task_id (str): ID of the task
  • Output: JSON string confirming task deletion

List Spaces

  • Output: JSON string containing list of spaces

List Lists

  • Input: space_name (str): Name of the space
  • Output: JSON string with list of lists

Limitations

  • Requires API key and Space ID for authentication and operations.
  • Limited to the capabilities provided by ClickUp's API endpoints.

Setup & Configuration

Prerequisites

  • A ClickUp account.
  • ClickUp API Key.
  • Master Space ID (for identifying workspace).

Authentication

  • Authentication is handled via API Key. Set the CLICKUP_API_KEY as an environment variable.
  • Additionally, set the MASTER_SPACE_ID environment variable.

Step-by-Step Guide

  1. Get your API key from ClickUp by visiting the Apps section in your ClickUp settings.
  2. Note your Master Space ID from the ClickUp web app.
  3. Set your environment variables:

bash export CLICKUP_API_KEY='your_api_key_here' export MASTER_SPACE_ID='your_master_space_id_here'

Testing Connection

Make a test API call to list spaces and verify the response to ensure the setup is correct.

How to Use in Agents

Configure the agent to use the ClickUp integration by enabling it and passing necessary parameters for tasks and space management as shown in the input schemas.

Best Practices

  • Use list endpoints first to find the IDs needed for tasks and lists.
  • Handle errors gracefully as API might have rate limits.

Reference Section

  • ClickUp API Docs Ensure integration within the Fluo Platform UI for ease of configuration without direct code manipulation.