LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page
  • How to configure ClickUp with Cortex
  • Prerequisites
  • Configure the integration in Cortex
  • How to connect Cortex entities to ClickUp
  • Auto discovery of spaces, folders, and tags
  • Import entities from ClickUp
  • Editing the entity descriptor
  • Specify a list for Initiative issues
  • Identity mappings
  • Expected results
  • Entity pages
  • Initiatives
  • Dev homepage
  • Scorecards and CQL
  • Create a task from an Initiative issue
  • Background sync
  • Still need help?​

Was this helpful?

Export as PDF
  1. Ingesting data into Cortex
  2. Integrations

ClickUp

Last updated 2 months ago

Was this helpful?

is a project management tool that combines tasks, document collaboration, and issue management in a single platform.

Integrating ClickUp with Cortex allows you to:

  • View task information directly on in Cortex

  • Create ClickUp tasks based on Initiatives directly from Cortex

  • Map ClickUp identities to users in Cortex

  • View open ClickUp tasks in the

  • Create that track progress and drive alignment on projects involving your ClickUp tasks

How to configure ClickUp with Cortex

Prerequisites

Before getting started:

  • Create a .

Configure the integration in Cortex

  1. In Cortex, navigate to the :

    1. In Cortex, click your avatar in the lower left corner, then click Settings.

    2. Under "Integrations," click ClickUp.

  2. Click Add configuration.

  3. Configure the ClickUp integration form:

    • API token: Enter your ClickUp API token.

  4. Click Save.

If you’ve set everything up correctly, you’ll see the option to Remove Integration in settings.

You can also use the Test configuration button to confirm that the configuration was successful. If your configuration is valid, you’ll see a banner that says “Configuration is valid. If you see issues, please see documentation or reach out to Cortex support.”

Note that mapping options will not appear in Cortex for users who have not finished user registration in ClickUp. If a user is partially registered, Cortex will filter them out of the mapping page.

How to connect Cortex entities to ClickUp

Auto discovery of spaces, folders, and tags

If your ClickUp space, folder, or tag don’t cleanly match the Cortex entity tag, you can override this in the Cortex entity descriptor.

Import entities from ClickUp

Editing the entity descriptor

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

You can find your folder ID or space ID in your ClickUp URL: https://app.clickup.com/:workspace_id/v/f/:folder_id/:space_id.

Mapping spaces by ID or name

When mapping spaces, you can use the ID or name for the space.

x-cortex-issues:
  clickup:
    spaces:
      - identifier: 123456789
        identifierType: ID
x-cortex-issues:
  clickup:
    spaces:
      - identifier: My Space
        identifierType: NAME

These blocks share the same fields:

Field
Description
Required

spaces

Denotes that mapping should be based on ClickUp spaces

true

identifier

Identifier for the space; either the full ID or name

true

identifierType

Type of identifier; either ID or NAME

true

Mapping folders by ID or name

When mapping folders, you can use the ID or name for the folder.

x-cortex-issues:
  clickup:
    folders:
      - identifier: 123456789
        identifierType: ID
x-cortex-issues:
  clickup:
    folders:
      - identifier: my-folder
        identifierType: NAME
Field
Description
Required

folders

Denotes that mapping should be based on ClickUp folder

true

identifier

Identifier for the folder; either the full ID or name

true

identifierType

Type of identifier; either ID or NAME

true

Mapping by tags

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

folders

Denotes that mapping should be based on ClickUp tags

true

name

Name for the tag

true

Specify a list for Initiative issues

You can also specify a ClickUp list to store all issues created via Cortex Initiatives. If Use list defined in entity YAML is toggled on in the Initiative issue creation form, Cortex will automatically create tasks in the specified list for a given entity.

If a list is not specified in an entity's YAML and Use list defined in entity YAML option is toggled on in the initiative issue creation form, Cortex will attempt to create a list in the mapped space or folder above.

Define one of these following blocks in an entity descriptor to specify a list for Initiative issues.

Specify list by ID

x-cortex-issues:
    clickup:
      initiativesList:
        id: 12345
Field
Description
Required

initiativesList

Denotes that Cortex

true

name

Name for the tag

true

Specify list by name

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

Identity mappings

Note that mapping options will not appear in Cortex for users who have not finished user registration in ClickUp. If a user is partially registered, Cortex will filter them out of the mapping page.

Expected results

Entity pages

Integrations - ClickUp

Tasks detected from your ClickUp instance will populate on the Issue tracking page in the entity's sidebar. Each row will show the following information (when available in ClickUp):

  • Task name (hyperlinked to task in ClickUp)

  • Project

  • Assignees

  • Priority

  • Created at

  • Due date

Initiatives

Initiatives allow you to set deadlines for specific rules or a set of rules in a given Scorecard and send notifications to users about upcoming due dates.

Dev homepage

Issues are refreshed every 5 minutes, or you can click Refresh ClickUp tasks to manually refresh issues.

Scorecards and CQL

With the ClickUp integration, you can create Scorecard rules and write CQL queries based on ClickUp tasks.

List of ClickUp tasks

Get ClickUp tasks meeting the given filter criteria.

  • Assignees

  • Created at

  • Creator

  • Due date

  • Folder

  • Priority

    • "Urgent", "High", "Normal," and "Low"

  • Status

  • Tags

  • Task name

Statuses are dependent on your own ClickUp configured statuses. Closed tasks are filtered out by default.

Definition: clickup.tasks()

Examples

To evaluate the maturity of an entity in a Scorecard, you can use this expression to make sure it has fewer than five unassigned ClickUp tasks:

clickup.tasks().filter((task) => task.assignees.length < 1).length < 5

You can also query for entities that don't have any urgent ClickUp tasks with a "security" tag:

clickup.tasks(priorities=["Urgent"], tags=["security"]).length == 0

Create a task from an Initiative issue

The issue configuration will apply to all entities that meet the filter criteria. Once an entity is passing the rule, Cortex will automatically close the associated ticket.

Background sync

Cortex conducts a background sync of ClickUp identities every day at 10 a.m. UTC. Pull requests and issues are refreshed every 5 minutes.

The following options are available to get assistance from the Cortex Customer Engineering team:

  • Chat: Available in the Resource Center

  • Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your Customer Success Manager.

By default, Cortex will use the (e.g. my-entity) as the "best guess" for ClickUp space, folder, or tag. For example, if your entity tag is my-entity, then the corresponding space, folder, or tag in ClickUp should also be my-entity.

See the for instructions on importing entities.

Cortex also supports mapping entities to ClickUp .

Cortex maps email addresses in your ClickUp instance to email addresses that belong to team members in Cortex. When is set up, users will be able to see their personal on-call status from the developer homepage.

From the Issues tab of an Initiative, you can automatically .

The ClickUp integration enables Cortex to pull information about tasks into the Dev homepage. You can find open tasks assigned to you under the .

See more examples in the in Cortex.

Initiatives allow you to set deadlines for specific rules or a set of rules in a given Scorecard and send notifications to users about upcoming due dates. You can create a ClickUp task from a failing rule in an Initiative. Learn more in .

Still need help?

Email: , or open a support ticket in the in app Resource Center

tags
identity mapping
Issues tab
CQL Explorer
Creating issues based on Initiatives
​
help@cortex.io
ClickUp
ClickUp personal API token
ClickUp settings page
entity pages
dev homepage
Scorecards
create a ClickUp task from a failing rule
Create services documentation
entity tag