CLICommand referencenotification
notification
Commands, arguments, and options for openship notification.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
openship notification
Manage notification channels, subscriptions and deliveries
openship notification|notifications [options] [command]| Subcommand | Purpose |
|---|---|
categories | List notification categories and groups |
channel | Configure notification delivery channels |
subscription | Choose which events use each channel |
defaults | Manage organization notification defaults |
deliveries | Inspect notification delivery attempts |
openship notification categories
List notification categories and groups
openship notification categories [options]openship notification defaults
Manage organization notification defaults
openship notification defaults [options] [command]| Subcommand | Purpose |
|---|---|
get | Show organization defaults |
set <file> | Set organization defaults (requires admin access) |
openship notification defaults get
Show organization defaults
openship notification defaults get [options]openship notification defaults set
Set organization defaults (requires admin access)
openship notification defaults set [options] <file>| Argument | Meaning |
|---|---|
file | JSON default containing category, defaultEnabled and defaultChannelKinds |
openship notification deliveries
Inspect notification delivery attempts
openship notification deliveries [options] [command]| Subcommand | Purpose |
|---|---|
list [options] | List deliveries and their status |
unseen-count | Count unseen deliveries |
seen <id> | Mark a delivery as seen |
openship notification deliveries list
List deliveries and their status
openship notification deliveries list [options]| Option | Meaning |
|---|---|
--unseen | Only unseen deliveries |
--limit <n> | Maximum deliveries (default: "50") |
openship notification deliveries seen
Mark a delivery as seen
openship notification deliveries seen [options] <id>| Argument | Meaning |
|---|---|
id | Delivery ID |
openship notification deliveries unseen-count
Count unseen deliveries
openship notification deliveries unseen-count [options]openship notification subscription
Choose which events use each channel
openship notification subscription [options] [command]| Subcommand | Purpose |
|---|---|
list | List your notification subscriptions |
set [options] <category> | Enable or disable delivery for one category and channel |
remove|rm <id> | Remove a notification subscription |
openship notification subscription list
List your notification subscriptions
openship notification subscription list [options]openship notification subscription remove
Remove a notification subscription
openship notification subscription remove|rm [options] <id>| Argument | Meaning |
|---|---|
id | Subscription ID |
openship notification subscription set
Enable or disable delivery for one category and channel
openship notification subscription set [options] <category>| Argument | Meaning |
|---|---|
category | Notification category ID |
| Option | Meaning |
|---|---|
--channel <id> | Channel ID |
--disabled | Disable this category/channel subscription |