From 77394bd390cf560c4cda53b3490f89f4c351295a Mon Sep 17 00:00:00 2001 From: "codegen-sh[bot]" <131295404+codegen-sh[bot]@users.noreply.github.com> Date: Tue, 19 Aug 2025 17:43:40 +0000 Subject: [PATCH] Add ClickUp integration documentation --- docs/capabilities/capabilities.mdx | 4 ++ docs/capabilities/interrupts.mdx | 43 +++++++++++++-- docs/docs.json | 1 + docs/images/clickup.png.placeholder | 5 ++ docs/integrations/clickup.mdx | 82 +++++++++++++++++++++++++++++ docs/introduction/overview.mdx | 15 ++++++ docs/settings/agent-permissions.mdx | 21 +++++++- 7 files changed, 167 insertions(+), 4 deletions(-) create mode 100644 docs/images/clickup.png.placeholder create mode 100644 docs/integrations/clickup.mdx diff --git a/docs/capabilities/capabilities.mdx b/docs/capabilities/capabilities.mdx index 5ae7d28b2..e7172f33c 100644 --- a/docs/capabilities/capabilities.mdx +++ b/docs/capabilities/capabilities.mdx @@ -20,6 +20,10 @@ Deep integrations with the tools your team already uses: Create and update issues automatically, track development progress, link code changes to tickets. + + Create and update tasks automatically, track development progress, link + code changes to tasks. + Chat directly in channels, get real-time notifications, share code snippets and updates. diff --git a/docs/capabilities/interrupts.mdx b/docs/capabilities/interrupts.mdx index 33f2521ef..b55b4f0c1 100644 --- a/docs/capabilities/interrupts.mdx +++ b/docs/capabilities/interrupts.mdx @@ -1,6 +1,6 @@ --- title: "Interrupts" -description: "How Codegen handles real-time interrupts from Slack and Linear while working" +description: "How Codegen handles real-time interrupts from Slack, Linear, and ClickUp while working" icon: "bolt" iconType: "solid" --- @@ -11,7 +11,7 @@ Codegen supports **real-time interrupts** that allow users to send additional me ## How Interrupts Work -When Codegen is actively processing a request, users can send follow-up messages through supported channels (Slack, Linear) that will be immediately delivered to the running agent as "interrupt messages." +When Codegen is actively processing a request, users can send follow-up messages through supported channels (Slack, Linear, ClickUp) that will be immediately delivered to the running agent as "interrupt messages." ### Key Features @@ -67,6 +67,28 @@ Codegen: Working on the authentication fix... Codegen: I see you've added 2FA requirements - incorporating that now! ``` +### ClickUp Interrupts + +In ClickUp, interrupts work through: + +1. **Adding comments** to the task Codegen is working on +2. **Updating the task description** with additional requirements +3. **Changing task priority or tags** (triggers re-evaluation) + + + **Note**: Codegen will respond automatically to your comments in ClickUp unless + another user is tagged in the same comment. + + +**Example:** + +``` +Task: Implement user authentication +Codegen: Working on the authentication implementation... +[User adds comment]: "Please also add password reset functionality" +Codegen: I see you've added password reset requirements - incorporating that now! +``` + ## Best Practices ### For Users @@ -80,6 +102,7 @@ Codegen: I see you've added 2FA requirements - incorporating that now! - **Provide context**: Explain how the new information relates to the original request - **Use @mentions in Slack**: Always mention @codegen in Slack channels (not needed in DMs) - **No mentions needed in Linear**: Codegen responds automatically unless other users are tagged +- **No mentions needed in ClickUp**: Codegen responds automatically unless other users are tagged ### Common Use Cases @@ -104,7 +127,7 @@ If your interrupt isn't acknowledged: 1. **Check the channel**: Ensure you're messaging in the same thread/issue 2. **Wait briefly**: The agent may be in the middle of a long operation 3. **Use @mentions in Slack**: Make sure you mentioned @codegen (required in channels, not DMs) -4. **Check for other tags in Linear**: If you tagged other users, Codegen won't respond automatically +4. **Check for other tags in Linear/ClickUp**: If you tagged other users, Codegen won't respond automatically 5. **Check agent status**: The agent may have completed or encountered an error ### Message Not Incorporated @@ -143,8 +166,22 @@ Codegen: I see you've added filter requirements - implementing date and category Codegen: Adding sorting options to the search as well! 📊 ``` +### ClickUp Task Example + +``` +ClickUp Task: "Build API integration" +Codegen: Working on the API integration... + +[User adds comment]: "Please add rate limiting" +Codegen: I see you've added rate limiting requirements - implementing that now! + +[User adds comment]: "Also add error handling for network failures" +Codegen: Adding robust error handling for network failures as well! 🛡️ +``` + ## Related Features - [Wake-up Triggers](/capabilities/wake-up) - How to initially trigger Codegen - [Slack Integration](/integrations/slack) - Complete Slack setup and usage - [Linear Integration](/integrations/linear) - Complete Linear setup and usage +- [ClickUp Integration](/integrations/clickup) - Complete ClickUp setup and usage diff --git a/docs/docs.json b/docs/docs.json index 47845451f..b84b84f53 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -34,6 +34,7 @@ "integrations/github", "integrations/slack", "integrations/linear", + "integrations/clickup", "integrations/notion", "integrations/figma", "integrations/circleci", diff --git a/docs/images/clickup.png.placeholder b/docs/images/clickup.png.placeholder new file mode 100644 index 000000000..0d336cfc9 --- /dev/null +++ b/docs/images/clickup.png.placeholder @@ -0,0 +1,5 @@ +This is a placeholder file. Please replace with an actual ClickUp integration screenshot image. + +Recommended dimensions: Similar to linear.png (1226921 bytes) +Recommended content: Screenshot of ClickUp integration with Codegen showing tasks, comments, and integration features. + diff --git a/docs/integrations/clickup.mdx b/docs/integrations/clickup.mdx new file mode 100644 index 000000000..3e6cf70e6 --- /dev/null +++ b/docs/integrations/clickup.mdx @@ -0,0 +1,82 @@ +--- +title: "ClickUp Integration" +sidebarTitle: "ClickUp" +icon: "list-check" +--- + +ClickUp is designed to streamline project management and task tracking for teams of humans and agents working together. It provides a flexible and powerful way to organize work, track progress, and collaborate on complex tasks. Codegen can help automate task creation, provide updates, and implement solutions directly linked to your ClickUp workspace. We recommend using Codegen to handle initial exploration and implementation of tasks, breaking down complex work into manageable pieces. + + + +## Installation + +Connect your ClickUp workspace to Codegen to enable agent interactions. + + + Authorize Codegen to access your ClickUp workspace via the API settings. + + + + API access allows agents to interact with tasks and projects according to + your permissions in ClickUp. + + +## Capabilities + +The ClickUp integration provides comprehensive project management capabilities: + +- **Create and update tasks automatically** - Generate new tasks and update existing ones based on development needs +- **Track development progress** - Monitor and report on the status of ongoing work +- **Link code changes to tasks** - Connect GitHub pull requests and commits directly to ClickUp tasks +- **Sync status updates** - Keep task statuses current as work progresses through different stages +- **Multi Agent Systems:** Create subtasks and assign child agents to break down complex tasks into manageable pieces. [Learn more](#multi-agent-systems). + +## Permissions + +The Codegen ClickUp integration requires the following permissions: + +- **Create tasks for your workspace** - Generate new tasks and tickets as needed +- **Create task comments and discussions** - Provide updates, ask questions, and facilitate collaboration +- **Read access to your workspace data** - Access existing tasks, projects, and team information +- **Write access to update tasks and projects** - Modify task status, assignees, and project details +- **Assign tasks to team members** - Route work to appropriate team members +- **Receive realtime updates about workspace changes** - Stay synchronized with workspace activity + +## How Agents Use ClickUp + +Agents use the ClickUp integration to streamline project management: + +- **Track Work:** Automatically update the status of tasks they are working on. +- **Link Code:** Connect implemented changes (GitHub PRs) directly to the relevant ClickUp task. +- **Provide Updates:** Post comments on tasks with progress reports, results, or questions. +- **Create Tasks:** Generate new tasks for follow-up work, bugs discovered, or sub-tasks. + +## Multi Agent Systems + +### Overview + +Once you've enabled ClickUp self-assign in the settings [page](https://www.codegen.com/settings/permissions), a codegen agent that has been assigned to a ClickUp task (or has been tagged in one) can spawn child agents +by creating subtasks and assigning itself to those subtasks. For each subtask that codegen assigns to itself, a child agent will be spawned and tasked with completing the subtask. Once the child agents are +finished with their tasks, they will notify their parent by sending it a message. The parent will then incorporate the child's work into its own as appropriate. + +### Best Practices + +#### Triggering the Child Agents + +If you'd like to have codegen break up a ClickUp task into smaller tasks and assign them to child agents, you should instruct it to do so in the +description of the original task. + +#### Shared Context + +Before creating subtasks and assigning them to child agents, the parent agent will produce scaffolding in the form of a git branch and include details +of this branch in the description of the subtasks. The child agents will then work off of this scaffolding branch. If you have specific scaffolding requirements +or context you'd like the child agents to share, please include them in the description of the parent task. + +#### Availability + +This feature is only available on the Team Plan. + diff --git a/docs/introduction/overview.mdx b/docs/introduction/overview.mdx index c7868c636..8fe397755 100644 --- a/docs/introduction/overview.mdx +++ b/docs/introduction/overview.mdx @@ -39,6 +39,14 @@ Codegen agents come equipped with a versatile set of tools and capabilities: Update ticket statuses, add comments, link PRs to issues, and create new tasks based on findings. + + Create and update tasks, add comments, link PRs to tasks, and track + development progress in your ClickUp workspace. + Send notifications, ask for clarification, report progress, and interact directly with your team in Slack channels. @@ -85,6 +93,13 @@ Integrating Codegen into your workflow is designed to be quick and easy: > Connect your Linear workspace to enable agent interactions with your issues. + + Connect your ClickUp workspace to enable agent interactions with your tasks. + Programmatically interact with agents using the Python SDK for advanced automation. diff --git a/docs/settings/agent-permissions.mdx b/docs/settings/agent-permissions.mdx index c3d7b26da..3aa96fbf5 100644 --- a/docs/settings/agent-permissions.mdx +++ b/docs/settings/agent-permissions.mdx @@ -54,6 +54,24 @@ This setting automates the workflow by updating issue status when the agent begi - **Default**: Disabled - **Use Case**: Enable for automatic issue tracking and improved project visibility +### Enable ClickUp Self-Assign + +**Allow the codegen agent to self-assign ClickUp tasks, enabling it to spin off other agents.** + +When enabled, the agent can assign itself to ClickUp tasks and potentially delegate work to other agent instances for parallel processing. + +- **Default**: Enabled +- **Use Case**: Disable if you prefer manual task assignment or want to limit agent autonomy + +### Enable ClickUp Auto State Change + +**When enabled, the agent will automatically move ClickUp tasks to 'In Progress' state when self-assigning them.** + +This setting automates the workflow by updating task status when the agent begins work, providing better visibility into what the agent is actively working on. + +- **Default**: Disabled +- **Use Case**: Enable for automatic task tracking and improved project visibility + ## Best Practices ### Security Considerations @@ -65,6 +83,7 @@ This setting automates the workflow by updating issue status when the agent begi ### Workflow Integration - Enable Linear Auto State Change if your team relies on Linear for project tracking +- Enable ClickUp Auto State Change if your team relies on ClickUp for task management - Coordinate permission settings with your existing CI/CD and review processes - Consider your team's preferred level of automation when configuring these settings @@ -72,5 +91,5 @@ This setting automates the workflow by updating issue status when the agent begi - [Repository Rules](/settings/repo-rules) - Configure repository-specific behavior - [Linear Integration](/integrations/linear) - Set up Linear workspace integration +- [ClickUp Integration](/integrations/clickup) - Set up ClickUp workspace integration - [Model Configuration](/settings/model-configuration) - Configure LLM settings -