Files
coder/docs/reference/cli/notifications.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

53 lines
1.5 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: notifications
description: Manage Coder notifications
---
2024-07-11 15:22:20 +02:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Manage Coder notifications
Aliases:
* notification
2024-07-11 15:22:20 +02:00
## Usage
```console
coder notifications
```
## Description
```console
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
2025-09-11 15:08:57 +02:00
server or Webhook not responding):
2024-07-11 15:22:20 +02:00
$ coder notifications pause
- Resume Coder notifications:
$ coder notifications resume
- Send a test notification. Administrators can use this to verify the notification
2025-09-11 15:08:57 +02:00
target settings:
$ coder notifications test
2025-09-11 15:08:57 +02:00
- Send a custom notification to the requesting user. Sending notifications
targeting other users or groups is currently not supported:
$ coder notifications custom "Custom Title" "Custom Message"
2024-07-11 15:22:20 +02:00
```
## Subcommands
2025-09-11 15:08:57 +02:00
| Name | Purpose |
|--------------------------------------------------|----------------------------|
| [<code>pause</code>](./notifications_pause.md) | Pause notifications |
| [<code>resume</code>](./notifications_resume.md) | Resume notifications |
| [<code>test</code>](./notifications_test.md) | Send a test notification |
| [<code>custom</code>](./notifications_custom.md) | Send a custom notification |