Start a Notify! Live Activity when a calendar event begins
This action will start a Live Activity, a live tile on your iPhone Lock Screen and Dynamic Island that updates in place while something is running.
Developer info
- API endpoint slug
- notifyapp.start_live_activity
- Filter code method
- Notifyapp.startLiveActivity.skip(string?: reason)
- Runtime method
- runAction("notifyapp.start_live_activity", {})
Action fields
Title Text input > Other
- Label
- What should the tile say?
- Helper text
- The headline on the tile, up to 120 characters. For example: Backup running.
- Slug
- title
- Required
- true
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setTitle(string: title)
Status Text input > Other
- Label
- What is the current state?
- Helper text
- A short state word shown on the tile, up to 40 characters. For example: Printing, Building, Out for delivery.
- Slug
- status
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setStatus(string: status)
Progress Text input > Other
- Label
- How far along is it, as a percentage?
- Helper text
- A number from 0 to 100, which draws a progress bar on the tile. Leave blank for no bar.
- Slug
- progress
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setProgress(string: progress)
Body Text input > Other
- Label
- What line of detail goes under it?
- Helper text
- A line of detail under the title, up to 300 characters.
- Slug
- body
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setBody(string: body)
Symbol Text input > Other
- Label
- Which symbol should it show?
- Helper text
- An SF Symbol name shown on the tile, for example printer.fill or shippingbox.fill.
- Slug
- symbol
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setSymbol(string: symbol)
Ends in Text input > Other
- Label
- How many seconds until it finishes?
- Helper text
- Draws a live countdown that ticks on its own. SECONDS, not milliseconds: 45 minutes is 2700. Maximum 86400.
- Slug
- ends_in
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setEndsIn(string: ends_in)
Tint Text input > Other
- Label
- What accent color should it use?
- Helper text
- A hex color for the tile accent, for example #FF9500.
- Slug
- tint
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setTint(string: tint)
Trailing Text input > Other
- Label
- What goes at the trailing edge?
- Helper text
- A short value shown at the trailing edge, up to 40 characters. For example a percentage or a count.
- Slug
- trailing
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setTrailing(string: trailing)
Steps Text input > Other
- Label
- How many stages are there in total?
- Helper text
- Turns the progress bar into stage segments. A number from 2 to 20, for example 5 for a five stage deploy. Use it with Completed stages.
- Slug
- steps
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setSteps(string: steps)
Step Text input > Other
- Label
- How many stages are done?
- Helper text
- How many stages are finished, from 0 up to the total. 3 of 5 lights the first three segments.
- Slug
- step
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setStep(string: step)
Button title Text input > Other
- Label
- What should the button say?
- Helper text
- Puts a tappable button on the tile, up to 20 characters, for example Pause or Dashboard. It needs a button address too.
- Slug
- button_title
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setButtonTitle(string: button_title)
Button url Text input > Link
- Label
- What should the button call?
- Helper text
- An https address. The phone calls it when the button is tapped, and Notify servers are not involved, so a webhook on your own network works. It needs a button label too.
- Slug
- button_url
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setButtonUrl(string: button_url)
Button open Dropdown list
- Label
- Should the button open the link?
- Helper text
- Yes opens the address like a link. No, the default, fires it quietly in the background as a webhook.
- Slug
- button_open
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setButtonOpen(string: button_open)
Metrics Text input > Long text
- Label
- Which values should it show side by side?
- Helper text
- Shows values side by side like a small dashboard. One per line as Label: Value, up to six lines. For example CPU: 87% on one line and Memory: 62% on the next.
- Slug
- metrics
- Required
- false
- Can have default value
- true
- Filter code method
- Notifyapp.startLiveActivity.setMetrics(string: metrics)
Applets using this Action
-
-
Watch the last ten minutes of the wash on your Lock Screen
-
Count down the last ten minutes of the dryer on your Lock Screen
-
Show a live tile while the garage door is open
-
Follow the oven on your Lock Screen from the moment it starts
-
Show a live tile while the sprinklers are running
-
Show a live tile while your Bosch or Siemens washer runs
-
Show a live tile while your Bosch or Siemens dryer runs
-
Show a live tile while the robot vacuum is cleaning
