Clockify
Source documentation for Clockify.
Field mappings¶
The source makes the following special mappings.
| From | To | Description |
|---|---|---|
| Tags | Task | Turns tags into tasks and splits the entry into as many pieces as the item has matching tags when tags-as-tasks-regex is set |
| Task | Summary or Description | Tasks are used for the summary of an entry; when tags-as-tasks-regex is set, Summary is set to the Description of the item |
CLI flags¶
Flags:
--clockify-api-key <KEY> Clockify API key
--clockify-url <URL> Clockify API base URL (default https://api.clockify.me/api/v1/)
--clockify-workspace <ID> Clockify workspace ID
--clockify-user <ID> Clockify user ID
Configuration options¶
| Config option | Kind | Description | Example |
|---|---|---|---|
| clockify-url | string | Clockify API base URL | clockify-url = "https://api.clockify.me/api/v1/" |
| clockify-api-key | string | API key gathered from Clockify1 | clockify-api-key = " |
| clockify-workspace | string | Clockify workspace ID2 | clockify-workspace = " |
| clockify-user | string | Clockify user ID | clockify-user = " |
Limitations¶
No known limitations.
Example configuration¶
source = "clockify"
target = "tempo"
clockify-url = "https://api.clockify.me/api/v1/"
clockify-api-key = "<YOUR API KEY>"
clockify-workspace = "<YOUR WORKSPACE ID>"
clockify-user = "<YOUR USER ID>"
tempo-url = "https://<org>.atlassian.net/"
tempo-username = "<jira username>"
tempo-password = "<jira password or API token>"
tempo-worker = "<jira username>"
tags-as-tasks-regex = '[A-Z]{2,7}-\d{1,6}'
round-to-closest-minute = true
force-billed-duration = true
-
As described in the API documentation, visit the settings page to get your API token. ↩
-
To get your workspace ID, navigate to workspace settings and copy the ID from the URL. ↩