Explore Plans
Mobile menu Close menu
Notify!

Create a Lock Screen widget

This action will create a Lock Screen widget on your device, a small card of live data you can pin to your Lock Screen.

Developer info

API endpoint slug
notifyapp.create_widget
Filter code method
Notifyapp.createWidget.skip(string?: reason)
Runtime method
runAction("notifyapp.create_widget", {})

Action fields

Title Text input > Other

Label
What should the widget be called?
Helper text
The headline on the widget, up to 120 characters. For example CPU Load.
Slug
title
Required
true
Can have default value
true
Filter code method
Notifyapp.createWidget.setTitle(string: title)

Value Text input > Other

Label
What is the big reading?
Helper text
The large value on the widget, up to 40 characters. Any short text works, so 92 and $1.2k are both fine.
Slug
value
Required
false
Can have default value
true
Filter code method
Notifyapp.createWidget.setValue(string: value)

Unit Text input > Other

Label
What unit goes beside it?
Helper text
A short unit shown next to the value, up to 12 characters. For example % or MB/s.
Slug
unit
Required
false
Can have default value
true
Filter code method
Notifyapp.createWidget.setUnit(string: unit)

Detail Text input > Other

Label
What line of detail goes under it?
Helper text
A line of detail under the value, up to 120 characters.
Slug
detail
Required
false
Can have default value
true
Filter code method
Notifyapp.createWidget.setDetail(string: detail)

Symbol Text input > Other

Label
Which symbol should it show?
Helper text
An SF Symbol name shown on the widget, for example gauge.with.needle or thermometer.
Slug
symbol
Required
false
Can have default value
true
Filter code method
Notifyapp.createWidget.setSymbol(string: symbol)

Tint Text input > Other

Label
What accent color should it use?
Helper text
A hex color for the widget accent, for example #7C3AED.
Slug
tint
Required
false
Can have default value
true
Filter code method
Notifyapp.createWidget.setTint(string: tint)

Progress Text input > Other

Label
How far along is it, as a percentage?
Helper text
A number from 0 to 100. Draws a progress bar on the widget. Leave it blank for no bar.
Slug
progress
Required
false
Can have default value
true
Filter code method
Notifyapp.createWidget.setProgress(string: progress)