synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-03 16:13:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
feature/notification-inbox
coder/docs/reference/cli/notifications.md
Danielle Maywood d2419c89ac feat: add tool to send a test notification (#16611) 
Relates to https://github.com/coder/coder/issues/16463

Adds a CLI command, and API endpoint, to trigger a test notification for
administrators of a deployment.
2025-02-19 13:08:38 +00:00

1.1 KiB
Generated
Raw Permalink Blame History

notifications

Manage Coder notifications

Aliases:

  • notification

Usage

coder notifications

Description

Administrators can use these commands to change notification settings.
  - Pause Coder notifications. Administrators can temporarily stop notifiers from
dispatching messages in case of the target outage (for example: unavailable SMTP
server or Webhook not responding).:

     $ coder notifications pause

  - Resume Coder notifications:

     $ coder notifications resume

  - Send a test notification. Administrators can use this to verify the notification
target settings.:

     $ coder notifications test

Subcommands

Name Purpose
pause Pause notifications
resume Resume notifications
test Send a test notification