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).
The actual section with timer and other configuration options will appear after you click the “Start / Stop timer” button (see the screenshot below) and it will be visible for the next time you come back to the issue again.
Manage your API token
Before you can start tracking your time and manage time entries - you should add your Clockify API token.
Add token
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).
Follow the short instructions on the loaded form, add your API token and you are ready to go (see the screenshot below).
Remove token
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
Start timer inside Jira issue
You just need to select your timer options once, then start the timer and all your selection preferences will be saved and preset automatically. So the next time you load your Jira issue details page you can just click the “Start” button without extra actions. The preference mapping is Jira user-project related.
Please follow those steps to run a timer:
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.
On the loaded form you can adjust the description of the time entry, by default it will be set as a Jira issue summary. The issue key will be added as a prefix automatically. So the final description will be look like: “RET-12 issue-summary-here”, where “RET-12” is Jira issue key.
By clicking the “Timer options” button you will see an additional section with different timer configurations like: workspaces, projects (clients), tasks, tags, billable, etc… See the screenshot below
Click the “Start” button to run a timer with selected options.
Stop timer inside Jira issue
To stop the timer, just navigate to the needed Jira issue details page, find “Clockify Integration for Jira” section and click the button with running counter on it (see the screenshot below).
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 from Clockify web/desktop application and stop in Jira issue
You can start a timer from any application and stop it inside Jira issue, so your 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.
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 work-log item based on the information (description, start date-time, duration) from the stopped time entry and behalf the Jira user who has stopped it.
View recent users time entries for particular Jira issue
As a manager that would like to track the recent activities of your team for particular Jira issues you don’t need to add any Clockify API tokens. Just load a needed Jira issue details page, navigate to the “Clockify integration for Jira” section, click the “User activities“ button and check entries (see screenshot below)
Enable / Disable plugin for particular Jira project
To disable the application from any Jira issue details page for specific 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 toggle the “Disable” button to enable / disable plugin (see screenshot below)
Setup Clockify synchronization (webhooks) with Jira
Quite often you need to update your time entries directly inside Clockify web/desktop app and you would like to have same updates inside Jira issue work-log items that are related to the existing entries. By using Clockify webhooks you can set up needed synchronization. Please follow this short video tutorial which shows what should be done - Clockify sync with Jira