---
title: "Comment Toolkit for Jira Documentation"
canonical: "https://support.covectors.io/space/CTFJ/1034092545/Comment%20Toolkit%20for%20Jira%20Documentation"
format: markdown
---
Comment Toolkit for Jira allows users to efficiently organize and label comment threads on Jira issues. It provides a dedicated interface for adding labels, filtering, and sorting comments. Additionally, it offers JQL functions to quickly locate issues based on comment labels, and enables users to trigger automation workflows based on label values.

## How it works

Once App is installed, you can get into the dedicated view named **“Comment Toolkit”** within the activity section in Jira issue. 

![Sans titre-20241003-091126.png](media://d0958089-6740-4bfa-b488-93089e6aa3b9)


The interface reproduces the comments listing and add an utilities left bar and additional filtering and sorting capabilities as listed below:

### Add comment Label via comments listing

Comments are listed in the right section. They are reproduced exactly as the comment native view within issue activity! 

![image-20241003-102551.png](media://dbb9db70-4152-41ef-9764-9911b8f3f442)

In each comment top corner you have an option to tag comment an exiting or a label to create as shown in screenshot above.

Added labels will be listed in the left bar detailed below.

### Filter Comments 

You have an option to list comments based on the following filters:

- List All issue comments
- List comments that have a label
- List comments that do not have a label

![Sans titre-20241003-093301.png](media://ece6bdd0-d005-407b-b21c-1c35959eccfc)

- **Pinned Labels and All Labels: **

Based on the existing comment labels listin you can select some labels to pin (as favorite) to get a quick access within the issue.

![Sans titre-20241003-093711.png](media://4831d81e-2080-4315-accb-a77c3db1ecaf)

> ℹ️ If you click on one the labels you get the list of comments filtered adequately

![Sans titre-1-20241003-094541.png](media://2e363be2-3a77-4c01-bfd2-e594f14bf0e3)

## Filter All comments

We added a filter bar to navigate comments easily. 

You get the following features within it: 

![Sans titre-20241003-104041.png](media://5bb7d8b9-69a8-4122-9465-7a04c4e7a09b)

- Text Search Bar to search within comment body
- Filter set to filter comment based on the following elements

## Filter issues based on comment labels

We have introduced within the App a new JQL function to be able to filter Jira issues based on label added to comments.

- Access JQL filtering view for JIRA
- Use the function “**CommentWithLabels**” where function takes in arguments list of labels you want to filter on. Each label must be added as a string (within double-quotes “) and separated by a comma (,)

> ⚠️ JQL functions can be used by following this syntax:
> ⚠️ 
> ⚠️ *issue in FUNCTION_NAME ()*

![image-20241003-110541.png](media://3de97fad-9123-4ea3-ad42-55c55dc413c5)

You can save the JQL result within a filter and use it after. Please note you can combine additional JQL component to your function to refine your search. 

## Automation based on comment labels

We made support for automation actions available in app based on comment labels. 

To configure your automation follow the below steps:

1- Go project automation panel

![Sans titre-20241022-132827.png](media://3cef9570-7646-452c-9edb-30b2c74ec624)

2- Create a new rule and set the automation trigger as “**Incoming webhook**”. The logic behind is when label is set in comment within a specific project information is sent to webhook and actions is trigger based on rule configured. 

3- Copy **webhook URL** and **Secret key.** Those information must be saved in App interface to inform App about details to be sent to Webhook (Step 5 below)

![image-20250319-232438.png](media://dc700e07-cc06-4546-92c9-ad8734c99e40)


Configure your rule to execute action based on comment label as following:

![image-20241022-134952.png](media://0dc164bd-acf9-428f-94a4-0d6b456d342c)

Where comment label value can be extracted via webhook data: as displayed in screenshot:

```
{{webhookData.label}}
```

4- Navigate to Jira Admin Settings > Apps > Comments Toolkit > Webhook Configuration

![Untitled-20250923-074437.png](media://204b6f93-cdf1-4524-845e-47280db719db)

5- Create a new webhook and set the copied URL and Secret Key with the associated project as following: 

![image-20250319-233131.png](media://f6a0fab8-a12e-4af8-a678-e180fad39de9)

Once stored, action will be triggered each time label is set in comment. 

## Dashboard widgets based on comments labels

If you are working with Jira dashboards and widgets, you can find a dedicated widget called “Cloud Widget label” to display comments label hit map. 

In order to use widget, edit your dashboard and search for Cloud Widget label in widget listing: 

![image-20241022-132228.png](media://d8af4d76-bf43-4b54-8bd4-f0192c78406c)

You need to select the project to display hitmap for, once done, you can see the following map: 

![image-20241022-132517.png](media://f6d8feaf-4ad3-496c-ba05-0900568ff5e2)