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]
SubcommandPurpose
categoriesList notification categories and groups
channelConfigure notification delivery channels
subscriptionChoose which events use each channel
defaultsManage organization notification defaults
deliveriesInspect 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]
SubcommandPurpose
getShow 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>
ArgumentMeaning
fileJSON default containing category, defaultEnabled and defaultChannelKinds

openship notification deliveries

Inspect notification delivery attempts

openship notification deliveries [options] [command]
SubcommandPurpose
list [options]List deliveries and their status
unseen-countCount unseen deliveries
seen <id>Mark a delivery as seen

openship notification deliveries list

List deliveries and their status

openship notification deliveries list [options]
OptionMeaning
--unseenOnly unseen deliveries
--limit <n>Maximum deliveries (default: "50")

openship notification deliveries seen

Mark a delivery as seen

openship notification deliveries seen [options] <id>
ArgumentMeaning
idDelivery 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]
SubcommandPurpose
listList 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>
ArgumentMeaning
idSubscription ID

openship notification subscription set

Enable or disable delivery for one category and channel

openship notification subscription set [options] <category>
ArgumentMeaning
categoryNotification category ID
OptionMeaning
--channel <id>Channel ID
--disabledDisable this category/channel subscription

On this page