ClickUp Integration

ClickUp

ClickUp is a service for project management and task tracking. It divides work into workspaces (teams), spaces, folders and lists. It supports custom fields, checklists, comments and attachments. LadyBug Tracker reports bugs into one ClickUp list.

At this time, this integration is in the beta stage.

Authentication

ClickUp uses personal API tokens. In the login window, enter these values:

• Username or Email — your ClickUp account.
• API Token — a personal API token.

To get the token, open Settings > Apps > API Token in ClickUp (https://app.clickup.com/settings/apps), then make the token. Copy the token into the API Token field. In the login window, the Generate API Token button opens this page.

The host address is always https://app.clickup.com. You do not need to change it.

Project setup (ClickUp service)

The plugin uses one ClickUp list. The project settings have these two items:

• Workspace selects the ClickUp team.
• Project selects the list. The plugin finds lists without a folder and lists in a folder.

LadyBug Tracker keeps the position from which you reported a bug in two custom fields. These fields must be on the list. To make them, do these steps:

1. Open the list, then open Custom Fields.
2. Make a field with the name Level and the type Text.
3. Make a field with the name Camera and the type Text.

The names must be exactly the same. If a field is missing, the plugin tells you when it verifies the project. It does not fail silently.

Free plan behaviour

A free ClickUp workspace has a limit on custom field uses, and it reaches this limit. The plugin can find that the workspace has a free plan, or ClickUp can refuse to write a custom field. In these cases, the plugin writes the Level and Camera values into the task description, not into custom fields. Thus you can report bugs without a paid plan. The plugin still reads custom fields. Thus the tasks from an earlier paid plan stay complete.

When the plugin writes the values into the description of a task, the values are part of the description. Thus it is not possible to update the values separately from the description.

Task status

The plugin gets the completed state of a task from the ClickUp status type. A task is completed when its status type is done or closed. Thus the list needs at least one open status, and at least one done or closed status.

Known limitations

• The ClickUp API (v2) cannot delete attachments. Thus you can add and view attachments, but you cannot delete them.
• Issue history is not available.
• The free plan has a limit on custom field uses. See Free plan behaviour above.

Project setup (Unreal Engine)

Open Project Settings > Plugins > LadyBug Tracker. Then do these steps:

1. Provider — select ClickUp.
2. Host — keep https://app.clickup.com.
3. Change Login Settings — enter your account and your API token.
4. Workspace — select your ClickUp team.
5. Project — select the list that gets the bug reports.

The plugin keeps these settings in Config/DefaultBugTracker.ini. You can share them with the team. The plugin keeps your login and your API token separately for each user. It keeps them only when Remember Me is enabled.