Docs · Sheet 04 of 05
Notifications
Each Job chooses when it notifies, with notify, and where, with channels.
When a Job notifies
| notify | Sends a notification | |
|---|---|---|
"stateChanges" | default | When a Job fails after a success, and when it succeeds after a failure. A Job's first Run notifies only if it fails. |
"everyRun" | After every Run. | |
"never" | Never. |
- Interrupted Runs never notify.
- A Run started from the phone always notifies, whatever
notifysays.
What it says
The title is the Job's name and what happened: failed, succeeded or recovered. The body is the result and one line of output, cut to 100 characters.
- On failure: the exit status and the last line of stderr.
- On success: how long it took and the last line of stdout, e.g.
1 min 12 s · done.
Channels
Set them up in Channels…, ⌘,. Each Channel has an On switch and a Send Test button. A Job sends to every Channel in its channels list, by default ["mac"].
Mac mac
Banners on this Mac, as macOS shows them. Nothing to set up. To turn them off, use System Settings › Notifications › Cuckoo.
ntfy ntfy · Recommended for iPhone
Sends to an ntfy topic. Install the ntfy app on your iPhone and subscribe to the same topic.
- Server:
https://ntfy.shunless you run your own. - Topic: required. On a public topic, its name is the password, so choose one nobody will guess.
- Token: optional, for a protected topic.
Failures arrive with high priority and ❌. Successes arrive with low priority and ✅.
Bellnod bellnod · By invitation
Sends each Job's state to Bellnod as a Notice. It needs a Source token from Bellnod, and Bellnod is open by invitation for now.
When a Channel fails
- Network errors and server errors are retried for up to 16 minutes. If the server asks to wait, Cuckoo waits.
- A wrong token isn't retried. The Channel shows
check the token. - When a Channel gives up, a Mac banner says so, and the Channel shows
Failing since 14:02. - A Job whose Channel is off or failing shows it in orange, e.g.
ntfy is failing. Nothing falls back to Mac on its own.