notifications
Usage: deepline notifications [options] [command]
Configure notification groups, destinations, and rules.
Options:
-h, --help display help for command
Commands:
configuration Read or atomically update notification groups and
rules.
events [options] List the Play events available to a notification.
list [options] List named notifications and their selected Play
events.
get [options] <name> Show one named notification.
add [options] <name>
edit [options] <name>
slack Select a channel from the connected Slack
integration.
pause [options] <name>
resume [options] <name>
test [options] <name>
delete [options] <name> Archive one notification without touching its
provider integration.
help [command] display help for command
Explanation:
Purpose:
Named notifications. Each one sends the play events you choose to a
connected target, such as a Slack channel or an email address.
When:
After publishing a play that runs on a cron or webhook trigger. A trigger
cannot report its own failure, so check that a failed run reaches someone.
Input:
notifications list what exists; read it before editing a rule
notifications events the play events a notification can receive;
do not guess event ids
notifications slack channels --search <words>
find a channel in the connected Slack
notifications add <name> --to slack:#channel --for play.cron.failed
notifications test <name> send a test message
Output:
The named notifications with their targets and events; add and test
confirm what changed or was sent.
Cost:
Free.
Avoid:
Reading the configuration needs no approval. Adding a rule or sending a
test changes something outside the run, so get the user's go-ahead first.
Slack itself is connected in Dashboard -> Integrations, not here.
Delivery retries are handled internally and are not configurable.
notifications configuration
Usage: deepline notifications configuration [options] [command]
Read or atomically update notification groups and rules.
Options:
-h, --help display help for command
Commands:
get [options] Show the effective group-based notification
configuration.
apply [options] <file> Atomically apply a configuration draft exported by an
agent or UI.
help [command] display help for command
notifications configuration get
Usage: deepline notifications configuration get [options]
Show the effective group-based notification configuration.
Options:
--json Emit JSON output
-h, --help display help for command
notifications configuration apply
Usage: deepline notifications configuration apply [options] <file>
Atomically apply a configuration draft exported by an agent or UI.
Arguments:
file JSON file, or - for stdin, containing expectedWorkspaceVersion and
one desired change
Options:
--dry-run Validate and display the file without saving it
--json Emit JSON output
-h, --help display help for command
notifications events
Usage: deepline notifications events [options]
List the Play events available to a notification.
Options:
--json Emit JSON output
-h, --help display help for command
notifications list
Usage: deepline notifications list [options]
List named notifications and their selected Play events.
Options:
--json Emit JSON output
--compact Emit only names, state, target, and event IDs
-h, --help display help for command
notifications get
Usage: deepline notifications get [options] <name>
Show one named notification.
Arguments:
name Notification name or ID
Options:
--json Emit JSON output
-h, --help display help for command
notifications add
Usage: deepline notifications add [options] <name>
Arguments:
name Group name, for example oncall
Options:
--to <target> Target; repeat email:name@example.com, slack:#channel, or
slack:member:U0123456789 (default: [])
--for <event> Legacy one-Slack-target event ID; repeat for more events
(default: [])
--dry-run Describe the notification without saving it
--json Emit JSON output
-h, --help display help for command
notifications edit
Usage: deepline notifications edit [options] <name>
Arguments:
name Notification name or ID
Options:
--to <target> New target, for example slack:#pipeline-alerts or
slack:member:U0123456789
--for <event> Replace selected events; repeat for more events. Run
notifications events to list them (default: [])
--dry-run Describe the change without saving it
--json Emit JSON output
-h, --help display help for command
notifications slack
Usage: deepline notifications slack [options] [command]
Select a channel from the connected Slack integration.
Options:
-h, --help display help for command
Commands:
channels [options]
help [command] display help for command
notifications slack channels
Usage: deepline notifications slack channels [options]
Options:
--search <text> Filter channel names
--json Emit JSON output
-h, --help display help for command
notifications pause
Usage: deepline notifications pause [options] <name>
Arguments:
name Notification name or ID
Options:
--dry-run Describe the change without saving it
--json Emit JSON output
-h, --help display help for command
notifications resume
Usage: deepline notifications resume [options] <name>
Arguments:
name Notification name or ID
Options:
--dry-run Describe the change without saving it
--json Emit JSON output
-h, --help display help for command
notifications test
Usage: deepline notifications test [options] <name>
Arguments:
name Notification name or ID
Options:
--dry-run Describe the external send without sending
--json Emit JSON output
-h, --help display help for command
notifications delete
Usage: deepline notifications delete [options] <name>
Archive one notification without touching its provider integration.
Arguments:
name Notification name or ID
Options:
--dry-run Describe the deletion without changing state
--json Emit JSON output
-h, --help display help for command