This action will create a Home Screen widget on your device, a tile that keeps showing the values you send until you change or remove it.
API endpoint slug
notifyapp.create_screen_widget
Filter code method
Notifyapp.createScreenWidget.skip(string?: reason)
Runtime method
runAction("notifyapp.create_screen_widget", {})
Action fields
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.createScreenWidget.setTitle(string: title)
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.createScreenWidget.setStatus(string: status)
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.createScreenWidget.setProgress(string: progress)
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.createScreenWidget.setBody(string: body)
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.createScreenWidget.setSymbol(string: symbol)
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.createScreenWidget.setEndsIn(string: ends_in)
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.createScreenWidget.setTint(string: tint)
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.createScreenWidget.setTrailing(string: trailing)
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.createScreenWidget.setSteps(string: steps)
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.createScreenWidget.setStep(string: step)
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.createScreenWidget.setButtonTitle(string: button_title)
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.createScreenWidget.setButtonUrl(string: button_url)
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.createScreenWidget.setButtonOpen(string: button_open)
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.createScreenWidget.setMetrics(string: metrics)
Notify!