Configuring and Using the Toggl

The Toggl Integration streamlines time tracking within your Jira issues. This guide details how to configure it after installation.

Prerequisites

Configuration

  1. After installing the app, open an issue in a project.

  2. Navigate to the issue detail view sidebar, and open the Toggl Integration.

    image-20240308-180232.png
  3. Click Open Toggl site. The Toggl profile page opens.

  4. Locate your API token within the profile settings. Click Click to reveal to view and copy the key.

    image-20240312-102236.png

You must ensure your API token remains private to prevent the sharing of sensitive information.

  1. Return to Jira and access the Toggl Integration section again.

  2. Paste your API key into the Token field and click Connect to save the configuration.

After that, Toggl is ready for use.

Using Toggl within an Issue

With the API key integrated, you can leverage Toggl directly within Jira:

Start Tracking

Clicking Start Tracker: issue key initiates time tracking for the specific issue in Toggl. A corresponding time entry is created in your Toggl Track account, automatically capturing the Jira issue key and summary. You can use the default settings, but alternatively, click Tracking settings to set your own tracking configuration. The options are:

  • Select Toggl workspace – Choose the specific workspace within your Toggl Track account where you want the time entry to be stored.

  • Select Toggl project – Designate the relevant project within your chosen workspace for this time entry.

  • Select Toggl tags – Assign relevant tags (keywords) to categorize the time entry within Toggl Track.

  • Apply JIRA issue labels – Map corresponding labels from the Jira issue to the Toggl time entry for further categorization.

  • Mark as billable – If the work on this issue is chargeable, select this option to mark the time entry as billable in Toggl.

Through Configuration options, you can choose to prefil these default options instead of filling them out mannually.

If users pay for Toggl Premium and they use Projects, there will also be an additional Tasks option. In that case, a project will have a Task created, there will be a field to select it.

Stop Tracking

Clicking Stop Tracker finalizes the time tracking and converts it into a work log for the associated Jira issue. At this stage, disabled Tracking settings with filled options that are selected for the running entry are displayed.

The Time logs tab allows you to view all the time logs related to the specific issue.

After stopping the tracker, you can view and manage your time logs directly on the Toggl Track Timer page. For more information on the Timer page, navigate to the Toggl Track documentation.