Our ClickUp integration allows you to import project management data directly into Keypup to gain visibility on tasks, due dates and comments across multiple projects.
Data coming from ClickUp can be used to calculate metrics such as progress of a sprint, overdue items or display cards in customized listing or boards.
What data do we collect?
Our ClickUp integration fetches the following entities:
Comments
This entity is exposed as a dataset on Keypup. Comments can be used to create a feed of updates or to create activity metrics.
E.g. Display comments for all open issues.
Issues
This entity is exposed on Keypup as part of the Issues & Pull Requests dataset. The priority of the issue (P1, P2, etc.) is imported as a label on each issue to ease filtering. This entity can be used to create activity metrics and listings.
E.g. Calculate the Mean Time To Closure on bugs.
Labels
This entity is exposed as a field on the Issues & Pull Requests dataset. It is used to refine metrics and queries based on labels used in ClickUp.
E.g. Retrieve only issues that have the “bug” label.
How often do we refresh data?
Updates from ClickUp are received in real time via webhooks.
If for any reason we are unable to set up real-time updates on ClickUp - e.g. the user who connected ClickUp has limited admin permissions in ClickUp - then we revert to long polling data every 20 minutes.
Whenever possible we recommend connecting ClickUp as a ClickUp admin to get the best experience on Keypup.
Improved reporting: Linking Issues to Pull Requests
Keypup uses context inference and link detection to automatically enrich your data, add new fields, and simplify your reporting. Context inference can be improved by linking pull requests to issues using auto-closing keywords.
How does it benefit my reporting?
Linking issues to pull requests allows us to populate and improve the following fields:
Issues & Pull Requests > Due on: When issues are linked to pull requests, Keypup automatically infers the due date by taking the soonest of all due dates across the pull request and its related issues.
Issues & Pull Requests > Resolution State: This field is only applicable to issues. It infers the implementation status of the issue by looking at the associated pull requests. The field can have the following values:
None: the issue has no attached pull requests. It is not being implemented
In progress: the issue has at least one open pull request attached to it
Implemented: all attached pull requests are merged or closed
These two fields can be used to refine your metrics and/or drill down on specific data. E.g. Retrieve the list of overdue issues which - on top of that - are not being currently resolved by a pull request.
How to link issues to pull requests?
There are several ways to reference a ClickUp issue from a pull request. All you need is the ID or URL of the ClickUp issue.
The easiest way to retrieve an issue ID is by looking at its URL. Assuming your issue URL is https://app.clickup.com/t/3yd0a3, the ID of the issue is 3yd0a3.
Option 1: Via the pull request title
To link a ClickUp issue by ID (e.g. 3yd0a3)- just insert it in the title of your pull request with a # (hashtag) prefix, for instance:
#3yd0a3 Resolve a problem with the login button
#3yd0a3 #3uf1f1 Fix multiple display bugs
Option 2: Via the pull request body or a commit message
You may also reference ClickUp issues from the description of your pull request or via commit messages using an auto-closing keyword such as fix, fixes, close, closes, resolve, and resolves. If using an issue ID, do not forget to prefix it with a # (hashtag), for instance:
closes #3yd0a3
closes: https://app.clickup.com/t/3yd0a3