veirox notify

Shared destinations, admin routing, your personal notification schedule, the inbox, and delivery logs

Synopsis

veirox notify <subcommand> [args] [flags]

Description

Every notification always lands in your in-app inbox, no matter what's configured below — that's the always-on system of record. destination and route are admin surfaces for org-wide Slack/Telegram/WhatsApp/Pushover channels; prefs and inbox are yours, personally.

Subcommands

CommandDescription
veirox notify destinationAdmin: manage shared Slack/Telegram/WhatsApp/Pushover destinations
veirox notify routeAdmin: route events to shared destinations by event/category/severity
veirox notify prefsYour personal channel matrix, mute, quiet hours, digest, and snooze
veirox notify inboxRead your in-app notification inbox + per-notification delivery status
veirox notify logsList notification delivery logs
veirox notify send <channel-id>Send a one-off notification

veirox notify destination

Admin CRUD over shared, org- or project-scoped Slack/Telegram/WhatsApp/Pushover destinations. Secrets (webhook URLs, tokens) are write-only — reads always return a redacted config.

CommandDescription
notify destination listList destinations
notify destination createCreate a destination — --kind, --name, --config-json
notify destination rm <id>Delete a destination
veirox notify destination create --kind slack --name '#ops-alerts' \
  --config-json '{"webhook_url":"https://hooks.slack.com/services/..."}'

veirox notify route

Admin routing rules — which shared destinations receive an event, filtered by event type and/or category with a minimum severity floor. Fires once per event, never per recipient.

CommandDescription
notify route listList routing rules
notify route createCreate a rule — --name, --destinations (required), plus --category, --min-severity
notify route rm <id>Delete a rule

veirox notify prefs

Your personal notification schedule — none of it touches the in-app inbox, which is always immediate. Only external personal channels (email, web push) are affected.

CommandDescription
notify prefs showShow your category matrix and schedule
notify prefs setSet personal channels for a category — --category, --channels
notify prefs mute / unmuteMute/unmute a category's external channels — --category
notify prefs quiet-hours set / clearDaily hold-off window — --start, --end, --tz
notify prefs digestBatch delivery cadence — --cadence instant|hourly|daily
notify prefs snooze / unsnoozePause everything external for a while — --for 8h
veirox notify prefs set --category security --channels email,web_push
veirox notify prefs quiet-hours set --start 22:00 --end 07:00 --tz UTC
veirox notify prefs snooze --for 8h

veirox notify inbox

The in-app inbox — the system of record. Every user-facing event lands here, always, regardless of external channel configuration.

CommandDescription
notify inbox listList notifications — --unread, --category
notify inbox read <id> / read-allMark one or all notifications read
notify inbox unread-countShow the unread count
notify inbox deliveries <id>Per-channel delivery status for one notification

veirox notify logs

List notification delivery logs

veirox notify logs

veirox notify send <channel-id>

Send a one-off notification

FlagTypeDefaultDescription
--messagestringmessage body
veirox notify send <uuid> --message 'hello from CI'

Exit codes

CodeMeaning
0Success.
1Generic error (network, API 5xx).
2Validation error (bad flag, missing required arg).
3Unauthenticated — run veirox login or set VEIROX_API_KEY.
4Not found (resource does not exist in this project).
5Permission denied (your role / API key lacks the scope).

See also