Clockify

This plugin allows you to track, start and stop Clockify timers on your Elgato Stream Deck.

Basic

Title: Override the title being set by the plugin, leave empty otherwise

API Key: (required) Provide your 48 characters long Clockify API Key, which is required for the plugin to work

Workspace Name: (required) Write the name of the workspace you want to run/track timers in

Project Name: (optional) Provide the name of an existing project to run/track a timer for

Task Name: (optional) Set the name of the project-specific task

Timer Name: (optional) Specify a name for the timer you want to run/track

Tags: (optional) Provide a comma separated list of tags to be assigned to the timer

Note: If your tag contains a comma (WHY?!) use a backslash to escape it, e.g. tag1,tag\,2,tag3

Billable (optional) Check or uncheck the box to run the timer as billable or non-billable

Advanced

Client Name: (optional) Set the client name assigned to the specified project

Title Format: (optional) Specify the format for the title to be displayed on the button.

This can include any of:

{workspaceName} : The workspace name

{projectName} : The project name

{taskName} : The task name

{timerName} : The timer name

{clientName} : The client name

{timer} : The current timer value when running. Blank when not running

Refresh Rate: (required) Define how often the API is being called, the default is 5 Seconds

Server Url: (required) Change from the default URL to the API URL of your own/company instance

Note: Starting with V1.11 the URL should not end with /v1

Clockify made quite a lot of changes to their plans and now only allows 30 API requests per hour for the whole workspace on their Free plan. This broke the Stream Deck Clockify plugin, as it used to ask for the running timer every 5 seconds, per button. On the Free plan you'd hit that limit within a few minutes and end up with a yellow triangle - which quite a few of you have reported. 🙈

In order to fix this, I've had to rewrite a lot of the plugin, which means:

There's a new default refresh interval "Automatic", which checks every 5 minutes on the Free plan and every 5 seconds on Paid plans

The timer on the button is counted locally and all buttons in the same workspace share a single check

The IDs of the workspace, project, task and tags are stored in the button settings, so restarting the Stream Deck doesn't look them up again

Starting or stopping a timer needs just one request

Nothing is sent while you're still typing in the settings, and a wrong setting is retried with an increasing delay instead of every second

If Clockify still answers with "Too many requests", the plugin pauses until it's allowed again and checks less often for the rest of the session

All existing buttons are reset to "Automatic", as the old settings page saved 5 seconds for every button, whether you picked it or not. If you want a different refresh rate, just select it again.

Hope this keeps your Stream Deck ticking! 🙂