| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
After installation
On the each Jira issue details page you should see an additional quick-add button “Start / Stop timer“ inside of issue content bar (see the screenshot below).
...
Navigate to any Jira issue details page and find the “Clockify Integration for Jira” section. If you cannot find it, please navigate and read the “After installation” part of the documentation.
Click the “Manage token” button which is located on the right side of the application (see the screenshot below).
Click the “Remove token” button, on the loaded form, to delete your API token (see the screenshot below).
Manage your timer with different scenarios
Start timer inside Jira issue
...
You can stop timer in any loaded Jira issue details page, but related Jira work-log items will be added to the issue where timer was started or to the issue which is detected by Jira issue key specified in the time entry description. If none of the cases happens, the timer will be stopped without any Jira work-log items operations.
Start timer
...
in Clockify web/desktop application and stop it in Jira
...
You can start a timer from any Clockify application and stop it inside Jira issue, so your in Jira issue. In the description of time entry you have to specify a Jira issue key like: RET-12 timer summary is here, where RET-12 is a Jira issue key.
Start timer in Jira and stop it in Clockify web/desktop application*
You can start a timer in any Jira issue and stop it later with one of the Clockify applications you prefer to use. The Jira issue work-log item will be added with data based on stopped time entry. To make it happen you have to specify the Jira issue key in the description of the time entry, like: “RET-12 issue-summary-here“, where “RET-12“ is Jira issue key.added automatically.
* Webhook setup is required.
Start and stop timer in Clockify web/desktop application*
You can start/stop a timer in one of the Clockify applications if you prefer to manage all in one place. In your time entry description, you have to specify a Jira issue key like - RET-12 timer summary is here, where RET-12 is a Jira issue key. Plugin will add the Jira issue work-log item automatically.
Current use case works only for users who have registered their Clockify API token in the add-on app.
* Webhook setup is required.
Add time entry manually in Clockify web/desktop application*
You can add your time entry manually in Clockify web/desktop application and specify a Jira issue key in the description, for example - RET-12 timer summary is here, where RET-12 is a Jira issue key. Plugin will add the Jira issue work-log item automatically.
Current use case works only for users who have registered their Clockify API token in the add-on app.
* Webhook setup is required.
Manage your time entry with different scenarios
Update time entry details in Clockify web/desktop application*
The application tries to keep data sync between Jira (issue work-log items) and Clockify (time entries). So when you update your time entry in the Clockify web/desktop application, the changes automatically apply to existing "mapped" issue work-log items.
* Webhook setup is required
Delete time entry in Clockify web/desktop application*
The application tries to keep data in sync between Jira (issue work-log items) and Clockify (time entries). So when you delete your time entry in the Clockify web/desktop application, the add-on tries to find a mapped Jira issue work-log item and sets the duration equal to 0. It also adds "out of sync with Clockify" to the item description.
* Webhook setup is required
Jira work-log items
For each running timer that we try to stop inside the Jira issue details page the application, automatically, will validate and if possible - add a new Jira (in Jira or Clockify apps), the add-on application validates and adds a Jira issue work-log item based on the information (description, start date-time, duration) from the stopped time entry and behalf the automatically, with the values based on the terminated entry, and behalf of Jira user who has stopped it.
View recent users time entries for particular Jira issue
...
Navigate to the Jira project and click the “Project settings” item which is located on the left sidebar menu (see screenshot below).
On the loaded page, in the same left sidebar menu, navigate and click the “Apps” drop-down. On the opened list find and click the “Clockify integration for Jira“ link (see screenshot below)
On the loaded page toggle the “Disable” button to enable / disable plugin (see screenshot below)
Setup Clockify synchronization (webhooks) with Jira
...
Manage additional timer options
You can configure additional timer option assignments between Jira and Clockify, so when you load Jira issue details page and after want to start a timer, enabled options will automatically preassigne needed values for you. To enable/disable it - just follow those steps:
Navigate to the Jira project and click the “Project settings” item which is located on the left sidebar menu (see screenshot below).
On the loaded page, in the same left sidebar menu, navigate and click the “Apps” drop-down. On the opened list find and click the “Clockify integration for Jira“ link (see screenshot below)
On the loaded page switch to the “Timer options” tab and enable/disable needed for you option (see screenshot below)
Assign Jira labels as Clockify tags
Automatically adds to the timer options Clockify tags, which have the same names as Jira labels. In case the item does not exist - it will be created automatically.
Assign Jira issue type as Clockify tag
Automatically adds to the timer options Clockify tag, which has the same name as Jira issue type. In case the item does not exist - it will be created automatically.
Assign Jira project as Clockify project
Automatically selects in the timer options Clockify project, which has the same name as Jira project. In case the item does not exist - it will be created automatically.
Assign Jira issue key as Clockify task
Automatically adds to the timer options Clockify task, which has the same name as Jira issue key. In case the item does not exist - it will be created automatically.
Assign Jira issue summary as Clockify task
Automatically adds to the timer options Clockify task, which has the same name as Jira issue summary.In case the item does not exist - it will be created automatically.
Setup Clockify synchronization (webhooks) with Jira
To support different scenarios for timer and time entry (please read sections above marked with *) - you should set up Clockify webhooks. Just follow this short video tutorial below and add 5 webhook events:
Timer started (anyone)Timer stopped (anyone)Time entry updated (anyone)Time entry deleted (anyone)Time entry created manually (anyone)
| Iframe | ||||||
|---|---|---|---|---|---|---|
|
After successful setup, you can use any suitable approach.
Setup timer badge for issue cards inside a Jira Board
| Note | ||||||
|---|---|---|---|---|---|---|
Feature is available only for
|
It's much easier to realize if someone is working on some issue (a Clockify timer is running) just by observing a timer badge on the issue card on Jira board, rather than opening each time Jira issue details page and track users activity section. After you enable timer badge option and someone will start a timer all other users can see an additional badge on the issue card like it shown on the image below.
...
Please note that it takes few seconds for Jira to show/hide badge on the card
Enable/Disable timer badge option
Navigate to the Jira project and click the “Project settings” item which is located on the left sidebar menu.
On the loaded page, in the same left sidebar menu, navigate and click the “Apps” drop-down. On the opened list find and click the “Clockify integration for Jira“ link.
After the page is loaded - find and enable “Enable timer badge on board card“ option. The special custom field will be created and assigned to needed screens automatically. Please see the image below how it should look like.
Please remember the name of created custom field. In our test example it’s - “RET: Clockify timer badge”
Add custom field to the card layout (board configuration)
Navigate to the board where you would like to have timer badge and open board configuration page, see image below.
On the loaded page select “Card layout“ tab and navigate to the “Active sprints“ section.
Add a custom field that was created for you when you enabled the timer badge option (in our test example it’s - “RET: Clockify timer badge”) and save changes.
Setup timer automation rules
You can manage an automation rules that will start/stop your Clockify timer each time you change your Jira issue status.
For example - when you set the status of your Jira issue to the
| Status | ||||
|---|---|---|---|---|
|
Next steps describe how you can configure those rules:
Navigate to the Jira project and click the “Project settings” item which is located on the left sidebar menu (see screenshot below).
On the loaded page, in the same left sidebar menu, navigate and click the “Apps” drop-down. On the opened list find and click the “Clockify for Jira“ link
On the loaded page find and click the “Timer automation“ tab (see screenshot below)
In the form that will appear select needed values (statuses) by which Clockify timer will be started or stopped automatically and click “Save” button to save your changes.