Skip to main content

ClickUp

CatalogScorecards

Summary

ClickUp is a project management tool. You can use ClickUp to drive insights into values such as:

  • Customer asks
  • Security tickets
  • Ongoing projects

Setup

When using ClickUp, you'll need to create a Personal API Token and add it under Settings → ClickUp.

caution

If you do not see the Settings page you're looking for in the sidebar, you likely don't have the proper permissions and need to contact your admin.

Catalog descriptor

If you need to override the automatic discovery, you can define the following block in your Cortex Catalog Descriptor.

You can map any number of ClickUp Spaces, Folders, and Tags to a Cortex entity. Folders and Spaces can be mapped by using either ID or name.

Mapping Space By ID

x-cortex-issues:
clickup:
spaces:
- identifier: 123456789
identifierType: ID

Mapping Space by name

x-cortex-issues:
clickup:
spaces:
- identifier: my-space
identifierType: NAME

Mapping Folder by ID

x-cortex-issues:
clickup:
folders:
- identifier: 123456789
identifierType: ID

Mapping Folder by name

x-cortex-issues:
clickup:
folders:
- identifier: my-folder
identifierType: NAME

Mapping by Tags

x-cortex-issues:
clickup:
tags:
- name: tag a
- name: tag b
- name: tag c

Specify a List for Initiative Task Creation

You can also specify a list to store all Cortex-created initiative tasks. If the Use list defined in entity YAML is checked off in the initiative issue creation form it will automatically create this entity's tasks in this list. If the list is not specified in the YAML and the Use list defined in entity YAML option is checked off in the initiative issue creation form, we will attempt to create a list in the mapped space or folder above.

Specify List By ID

x-cortex-issues:
clickup:
initiativesList:
id: 12345

Specify List By Name:

x-cortex-issues:
clickup:
initiativesList:
name: Cortex Initiative Issues