Read more about this feature in the announcement.
Get the App
Download the app on your iPhone or iPad here:
Feature Overview
Calendar Syncing
Apple Health
Apple Reminders
Apple Home
Shortcuts
Let's explore each one.
Calendar Syncing
To make calendar sharing secure, Companion uses the EventKit library to sync events from multiple calendars (Apple, Outlook, etc) to your TRMNL account.
(If you use Google Calendar, check out our native Google Calendar plugin)
Step 1 - create a Calendar plugin
Inside TRMNL, navigate to Plugins and create (or update) an existing Calendar* instance, setting the "Data Provider" value to "iPhone App" at the top of the settings form.
* Apple, Outlook, Fastmail, Nextcloud, CalDAV
Step 2 - Sync your calendars
Inside the TRMNL Companion iOS App, pull down on the "Plugins" tab to refresh the list. Select the Calendar plugin instance(s) you set up in Step 1 and sync as many calendars as you'd like.
It's OK to mix and match providers. For example you could sync a personal Google Calendar and a work-only Outlook calendar. The calendars themselves will not be shared -- rather, their events will be pulled independently and synced with your TRMNL account.
Going forward, calendar events should automatically sync in the background.
Apple Health / Reminders / Home
Syncing Apple data to TRMNL is easy.
Step 1 - Create a Plugin
Inside the TRMNL web app, navigate to Plugins > Private Plugin > New and create a plugin with the "Webhook" strategy.
Step 2 - Connect Data
Back inside TRMNL Companion, pull down from the top of your Plugins tab to refresh the list and select the plugin you just created.
Each category of data will appear in a dropdown menu, and you must enable permissions to share that type of data with TRMNL. Then you can toggle on/off data sources individually.
This data will appear inside "nodes" of your TRMNL plugin. For example all Reminder data will appear inside a {{ reminders }} block and so on. Learn how to use this data here and here.
Apple Shortcuts
Shortcuts is a powerful "no code" utility built and maintained by Apple. This lets Apple users coordinate complex sequences of triggers and actions spanning many pieces of technology.
For example, with Shortcuts you can make a smart light turn on when you arrive home. Or draft a Note with the current timestamp whenever your back door is opened. The possibilities are endless.
With TRMNL Companion, these possibilities include creating and syncing custom plugins for your device.
Step 1 - Create a Plugin
Inside the TRMNL web app, navigate to Plugins > Private Plugin > New and create a plugin with the "Webhook" strategy.
Step 2 - Create a Shortcut
Inside your Apple product > Shortcuts, create a Shortcut with whatever inputs or triggers you'd like. Learn how to use Shortcuts generally here.
When you're ready to push that data to TRMNL, create a new step, search for TRMNL Companion, then choose "Send Data to Plugin."
Map your desired data inside the row labeled "JSON Data," then (optionally) customize the Key value "data" to something else.
After saving your Shortcut, tap the ▶ (play) icon to test it. After seeing a success message, head back to your plugin inside the TRMNL web app. Click "Edit Markup" in the top right, then find your data inside the "Your Variables" section below the markup preview area.
Customize your sync experience
By default, TRMNL Companion will sync new calendar automatically in the background. But this may functionality may be paused if you "force close" the application.
If you'd like to increase the sync frequency, set up an Apple Shortcut as follows.
Step 1 - Create a Shortcut
Open the Shortcuts app on your iPhone. Click the "+" symbol to add a new Shortcut. Search for "TRMNL" and select the TRMNL Companion app.
Step 2 - Enable the Shortcut
After selecting the TRMNL Companion app, tap the Sync to TRMNL option. On the next screen we suggest disabling the "Show When Run" toggle.
If you'd like to test this out, tap the ▶ (play) icon in the bottom right corner.
Step 2 - Automate the Shortcut
Tap the back button in the top left of your Shortcuts app to return to your home screen. Next, tap Automation in the bottom menu.
Here you can set up a schedule, combining a time of day with the Sync Shortcut we created a moment ago. Click the image below to see it expanded.
Note our recommendation to set "Run immediately" and disable "Notify when run," which will otherwise create a banner notification on your home screen.
Troubleshooting
Please send feedback to [email protected].
Security
TRMNL Companion uses native "Kit" modules by Apple. Each kit's data must be explicitly permitted by you. Downloading TRMNL Companion does not grant TRMNL personal information unless you login into your web account, approve permissions, then consent to additional data sharing.
Regarding calendar specifically, Companion uses the EventKit library to fetch only the details need to populate a calendar -- an event's title, description, start/end time, status, and calendar name. hackers are welcome to Man-In-The-Middle the network request:
{
"end" => "18:00",
"start" => "16:00",
"status" => "accepted",
"all_day" => false,
"calname" => "ryan@usetrmnl",
"summary" => "Support chats",
"end_full" => "2025-10-02T18:00:00.000Z",
"date_time" => "2025-10-02T16:00:00.000Z",
"start_full" => "2025-10-02T16:00:00.000Z",
"description" => "Respond to customers from my walking standup desk"
}
TRMNL Companion also only retrieves events from the past 7 days, to the next 30 days.