2026-08-11 11:22:55 -04:00
|
|
|
---
|
|
|
|
|
# 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:
|
|
|
|
|
|
2025-01-03 18:12:59 +05:00
|
|
|
* 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
|
2025-02-19 14:08:38 +01:00
|
|
|
|
|
|
|
|
- Send a test notification. Administrators can use this to verify the notification
|
2025-09-11 15:08:57 +02:00
|
|
|
target settings:
|
2025-02-19 14:08:38 +01:00
|
|
|
|
|
|
|
|
$ 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 |
|