Skip to content

For the complete documentation index, see llms.txt.

ClickUp

A ClickUp status trigger starts Promptless documentation work when a task moves into a status you choose. Use it when your team tracks product work in ClickUp and moves a task to a status such as Ready for docs when its documentation should start.

Connecting ClickUp sets up status-change delivery to Promptless. A ClickUp status trigger then chooses which statuses start documentation work.

  • ClickUp connected to Promptless. If it isn’t connected yet, connect it first.
  • An organization admin role, to add triggers.
  • The exact name of each ClickUp status that should start documentation work.

Skip this section if ClickUp is already connected on the Integrations page.

You need a ClickUp account in the workspace whose task statuses you want Promptless to watch.

  1. On the Promptless Integrations page, select Connect ClickUp.

  2. If ClickUp asks you to log in, log in with the ClickUp account you want Promptless to use.

  3. In ClickUp, authorize Promptless for the workspace.

  4. After ClickUp redirects you to Promptless, confirm that ClickUp shows as connected on the Integrations page.

Promptless creates a webhook in your ClickUp workspace that sends task status changes to Promptless. ClickUp calls a workspace a team, so the ClickUp card lists your authorized workspaces as teams.

Promptless watches one workspace. When the ClickUp account belongs to more than one, Promptless watches the first workspace ClickUp returns for it. To choose the workspace, connect with a ClickUp account that belongs to that workspace only.

  1. On the Triggers tab of the Configuration page, select Add an automatic or scheduled trigger.

  2. Under Tasks & tickets, select A ClickUp status.

  3. In Which statuses?, add each status that should start documentation work, such as ready for docs.

  4. Select Add trigger.

To add the same trigger in YAML mode, add a clickup trigger to the triggers section:

triggers:
clickup-status:
trigger_type: clickup
match:
- statuses: [ready for docs, released]

The trigger map key, such as clickup-status, is yours to name. The trigger_type value clickup is a fixed type identifier.

A ClickUp status trigger matches on one field, statuses. Each clause under match needs at least one status. A task matches when it moves into any listed status, and separate clauses are ORed.

Promptless compares the full status name and ignores capitalization, so Ready for docs matches ready for docs. The trigger saves any status name you enter, and a misspelled status never matches. Copy status names from ClickUp.

The trigger watches every list, folder, and space in the connected workspace. To limit which tasks start documentation work, use a status that only those tasks reach.

When a task matches, Promptless receives the task ID and its previous and new status. Promptless then reads these details of the task:

  • The task name, description, status, tags, and URL.
  • The space, folder, and list the task belongs to.
  • Its dates, such as created, due, and closed.
  • Custom fields whose names contain PRs or Notes.

Put what documentation needs to know in the task description, and link related pull requests in a custom field whose name contains PRs, such as Linked PRs. With GitHub or GitLab connected, Promptless then reads the code change behind the task.

Promptless reports the run through your usual Slack or Microsoft Teams notification and, when your publishing policy calls for one, a documentation PR. The ClickUp task stays unchanged.

A ClickUp status trigger acts on status changes made after you add it. Backfill covers GitHub PR and GitLab merge request triggers only.

A product team plans features in ClickUp. Each feature task carries a Linked PRs custom field, and the team’s workflow ends with a Ready for docs status. The docs lead adds a ClickUp status trigger with statuses: [ready for docs].

An engineer moves the task “Add CSV export to reports” to Ready for docs. Promptless reads the task description and, through the team’s GitHub connection, the pull request in Linked PRs. It drafts an update to the reports guide that names the export format and the columns the pull request adds. Following the publishing policy, Promptless opens a documentation PR or leaves a draft suggestion, and sends the usual notification.

Troubleshoot a status change that started no work

Section titled “Troubleshoot a status change that started no work”

Check each of these in order:

  1. The status name in the trigger matches the ClickUp status, apart from capitalization.
  2. The task belongs to the workspace Promptless watches. Promptless watches one workspace per connection, as Connect ClickUp describes.
  3. The trigger shows as active on the Triggers tab. A trigger shows as inactive while ClickUp is disconnected.

If all three hold, disconnect ClickUp on the Integrations page and connect it again. Connecting again creates a new webhook in your ClickUp workspace.