Skip to content
SHC Docs

shc notification test

dispatch a synthetic notification through a named rule

Trigger a one-shot notification against a configured rule. The message is prefixed [TEST] and the payload carries test: true, so the receiver can tell it from a real event. Bypasses the rule’s cooldown and debounce, but one rule can be tested once every 30 seconds. Useful for verifying that channel credentials and template rendering still work after a config change. To raise a real event that a rule’s cooldown and debounce apply to, use shc notification emit.

shc notification test [rule] [flags]
--code string synthetic event code to dispatch (default "V200700NTFSNT")
-h, --help help for test
--message string synthetic event message (default "notification test")
--payload string JSON payload to attach to the synthetic event
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)