Pages in Reference

noust notify

Notification channels: what Noust tells you, and where.

Reference Updated 29 October 2026 View as Markdown

Shell

noust notify [OPTIONS] COMMAND [ARGS]...

Subcommands: channel, deliveries, events, list, retry, telegram-chats, test

noust notify channel

Add, change and remove notification channels.

Shell

noust notify channel [OPTIONS] COMMAND [ARGS]...

Subcommands: remove, set

noust notify channel remove

Remove a channel. A default channel is emptied instead.

Shell

noust notify channel remove [OPTIONS] NAME

Arguments: name

Option	What it does	Default
`--team`	Remove this team's channel NAME.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify channel set

Create or change a channel, keeping what is not mentioned.

Shell

noust notify channel set [OPTIONS] NAME

Arguments: name

Option	What it does	Default
`--type`	The channel's type.
`--enable`, `--disable`	Turn the channel on or off.
`--set`	A setting of the type (chat_id, device, mention_role_id...). Not a credential.
`--secret`	Ask for a credential (webhook_url, bot_token, user_key...), hidden.
`--secret-stdin`	Read one credential from standard input.
`--event`	This channel's own switch for an event (see 'noust notify events').
`--clear-events`	Forget this channel's own event switches.
`--route-app`	Only this application (a * pattern works).
`--route-project`	Only this project.
`--route-environment`	Only this environment (or project/environment).
`--route-tag`	Only applications with this tag.
`--min-severity`	Skip everything below this severity.
`--server-events`, `--no-server-events`	With a route: also hear what is about the server, not an application.
`--clear-route`	Remove the channel's route.
`--quiet`	Quiet hours, such as 22:00-07:00.
`--quiet-timezone`	The time zone of the quiet hours (UTC by default).
`--quiet-allow`	The lowest severity that still gets through the quiet hours (failed by default).
`--no-digest`	Deliver what the quiet hours held one by one.
`--clear-quiet`	Remove the channel's quiet hours.
`--flood`	At most MAX messages in any MINUTES minutes, such as 20/10; the rest arrive as one.
`--clear-flood`	Remove the channel's anti-flood cap.
`--summary-at`	Send everything below --summary-below once a day at this time, as one message.
`--summary-timezone`	The time zone of the summary.
`--summary-below`	What waits for the summary: what is below this severity (warning by default).
`--summary-days`	The days it goes out on, such as mon,wed,fri (every day by default).
`--clear-summary`	Remove the channel's summary.
`--team`	Make it the channel of this team: it hears only that team's applications. NAME is then what the team calls it.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify deliveries

Show the record of deliveries: what went out, what waits and what failed.

Shell

noust notify deliveries [OPTIONS]

Option	What it does	Default
`--state`	Only deliveries in this state.
`--channel`	Only deliveries to this channel.
`--limit`		`30`
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the deliveries as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify events

List the events a channel may be switched for, and which are on.

Shell

noust notify events [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the events as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify list

List every notification channel, the default of each type and your own.

Shell

noust notify list [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the channels as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify retry

Send again what failed, now.

Shell

noust notify retry [OPTIONS] [DELIVERY_ID]

Arguments: delivery_id

Option	What it does	Default
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify telegram-chats

List the chats the Telegram bot can send to, with their ids.

Shell

noust notify telegram-chats [OPTIONS]

Option	What it does	Default
`--channel`	The Telegram channel whose bot is asked.	`telegram`
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the chats as a JSON array.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust notify test

Send a test message through CHANNEL.

Shell

noust notify test [OPTIONS] CHANNEL

Arguments: channel

Option	What it does	Default
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.