Automating Tyme with Shortcuts

⚠️ Warning ⚠️
The shortcut plugin for Tyme is currently in closed beta and not public available. It will be released with the release of iOS 15 and macOS 12 Monterey this fall.

Shortcuts are a great way to get even more out of Tyme by automating tasks or passing data to Tyme or from Tyme to other applications.

Tyme provides several shortcut actions that are added to the list of actions in the Shortcuts app when Tyme is installed on your device. Just search for Tyme to get a list of all available actions.

You can also trigger shortcuts directly from Tyme for various actions. Take a look at the Shortcut Hooks.

New to shortcuts? 🤷‍♂️
To get an overview of what you can do with the Shortcuts app, refer to the Apple Support Article or take a look at the Shortcuts User Guide.

Shortcuts

Below you find a complete list of shortcut actions Tyme currently supports. Most actions can be chained. For example you can pass the result of the Get Projects action into the Set Project Values action to bulk edit projects.

Add Category

Let's you add a new category.

Input Parameters

Name Type
Name String

Response

Name Type
category Category

Add Note To Running Timer

Add a note to the running timer.

Input Parameters

Name Type
note String

Response

Name Type
timeEntry TimeEntry

Add Project

Add a new project. Optionally a category can be specified, that the project will be connected to.

Input Parameters

Name Type
name String
Alternative Parameters:
category Category
categoryID String

Response

Name Type
project Project

Add Task

Add a new task to a project. Supports all task types (time-based, mileage and expenses). Optionally provide a parent tasks if the new task should be a sub-task or an expense.

Input Parameters

Name Type
name String
category Category
project Project
task Task
type TaskType
expenseGroupName String
Alternative:
projectID String

Response

Name Type
task Task

Add Time

Add a new time entry to an existing task.

Input Parameters

Name Type
name String
category Category
project Project
task Task
from Date
to Date
Alternative:
taskID String

Response

Name Type
timeEntry TimeEntry

Delete Categories, Projects or Tasks

Delete Categories, Projects or Tasks.

Input Parameters

Name Type
categories Category
projects Project
tasks Task

Response

Name Type
Number of deleted objects Int

Delete Time Entries

Delete Time Entries.

Input Parameters

Name Type
timeEntries TimeEntry

Response

Name Type
Number of deleted time entries Int

Get Categories

Search for categories by name or their archived state.

Input Parameters

Name Type
name String
archived Boolean
Alternative:
categoryID String

Response

Name Type
categories Category

Get Projects

Search for projects.

Input Parameters

Name Type
name String
category Category
archived Boolean
dueDate Date
Alternative:
projectID String

Response

Name Type
projects Project

Get Running TimeEntries

Returns all running time entries.

Input Parameters

Name Type
None -

Response

Name Type
timeEntries TimeEntry

Get Tasks

Search for tasks.

Input Parameters

Name Type
category Category
project Project
name String
type (time, mileage, expense)
completed Boolean
billable Boolean
dueDate Date
Alternative:
taskID String

Response

Name Type
tasks Task

Get Time Entries

Search for time entries.

Input Parameters

Name Type
category Category
project Project
task Task
from Date
to Date
billingState (billable, unbillable, billed, unbilled, paid)
note String
teamMember TeamMember
Alternative:
timeEntryID String

Response

Name Type
timeEntries TimeEntry

Get Team Members

Returns a list of team members. Can be queried by name or email.

Input Parameters

Name Type
name String
email String

Response

Name Type
teamMembers TeamMember

Get Todays Working Hours

Get Todays Working Hours. Returns zero for weekend or vacation days

Input Parameters

Name Type
None -

Response

Name Type
hours Float

Set Category Values

Update details of a category.

Input Parameters

Name Type
category Category
name String
archived Bool
Alternative:
categoryID String

Response

Name Type
category Category

Set Project Values

Update details of a project.

Input Parameters

Name Type
archived Boolean
name String
dueDate Date
category Category
plannedDuration Duration
plannedBudget Duration
note String
Alternative:
projectID String

Response

Name Type
project Project

Set Task Values

Update details of a task.

Input Parameters

Name Type
project Project
task Task
name String
completed Boolean
dueDate Date
plannedDuration Duration
plannedBudget Duration
billable Boolean
hourlyRate Float
roundingMethod (up, down, round)
roundingMinutes Int
note String
price Float
quantity Float
kilometerRate Float
Alternative:
taskID Task

Response

Name Type
task Task

Set Time Entry Values

Update details of a time entry.

Input Parameters

Name Type
timeEntry TimeEntry
startTime Date
endTime Date
note String
traveledDistance Distance

Response

Name Type
timeEntry TimeEntry

Start Timer

Starts a new timer

Input Parameters

Name Type
category Category
project Project
task Task
Alternative:
taskID String

Response

Name Type
timeEntry TimeEntry

Stop Timer

Stops all running timers

Input Parameters

Name Type
None -

Response

Name Type
timeEntry TimeEntry

Shortcut Hooks

You can run shortcuts when certain actions occur in Tyme. Just open the Preferences > Plugins > Shortcut Actions and activate the ones you need. Most actions send an input to the shortcut that you can use to process the data. For example the Started a timer action passes the ID of the new time entry to the shortcuts, that you can use to get details of the time entry, its task or other values by chaining your shortcut with the Get Time Entries shortcut.

Started a timer

This action is triggered when you start a timer. The ID of the new time entry is send as an input to the shortcut.

Input Parameters

Name Type
timeEntryID String

Stopped a timer

This action is triggered when you stop a timer. The ID of the time entry is send as an input to the shortcut.

Input Parameters

Name Type
timeEntryID String

Reached daily working hours

This action is triggered when you have reached your daily working hours.

Input Parameters

Name Type
None -

Project archived / de-archived

This action is triggered when a project is archived or un-archived

Input Parameters

Name Type
projectID String

Task completed / uncompleted

This action is triggered when a task is completed or uncompleted

Input Parameters

Name Type
taskID String

Types

Category

Name Type
ID String
Name String
Archived Boolean

Project

Name Type
ID String
Category ID String
Archived Boolean
Name String
Due Date Date
Planned Time Duration
Planned Budget Currency Amount
Note String

Task

Name Type
ID String
Category ID String
Project ID String
Task ID String
Name String
Completed Boolean
Due Date Date
Planned Time Duration
Planned Budget Currency Amount
Billable Boolean
Hourly Rate Currency Amount
Rounding Method (up, down, round)
Rounding Minutes Int
Note String
Price (Expense) Currency Amount
Quantity (Expense) Float
Kilometer Rate (Mileage) Currency Amount

Time Entry

Name Type
ID String
Task ID String
Type (timed, mileage, expense)
Exact Time Duration
Rounded Time Duration
Start Time Date
End Time Date
Note String
Revenue Currency Amount
Traveled Distance (Mileage) Distance
Price (Expense) Currency Amount
Quantity (Expense) Float
Team Member TeamMember

Team Member

Name Type
ID String
Name String
Email String