Skip to content

Commit cf57208

Browse files
committed
update/reorg notifications
1 parent 17233c4 commit cf57208

File tree

1 file changed

+35
-33
lines changed
  • docs/admin/monitoring/notifications

1 file changed

+35
-33
lines changed

docs/admin/monitoring/notifications/index.md

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,50 +14,64 @@ user(s) of the event.
1414

1515
Coder supports the following list of events:
1616

17-
### Workspace Events
17+
### Template Events
1818

19-
These notifications are sent to the workspace owner:
19+
These notifications are sent to users with **template admin** roles:
2020

21-
- Workspace created
22-
- Workspace deleted
23-
- Workspace manual build failure
24-
- Workspace automatic build failure
25-
- Workspace manually updated
26-
- Workspace automatically updated
27-
- Workspace marked as dormant
28-
- Workspace marked for deletion
21+
- Report: Workspace builds failed for template
22+
- This notification is delivered as part of a weekly cron job and summarizes
23+
the failed builds for a given template.
24+
- Template deleted
25+
- Template deprecated
2926

3027
### User Events
3128

3229
These notifications are sent to users with **owner** and **user admin** roles:
3330

31+
- User account activated
3432
- User account created
3533
- User account deleted
3634
- User account suspended
37-
- User account activated
3835

3936
These notifications are sent to users themselves:
4037

4138
- User account suspended
4239
- User account activated
4340
- User password reset (One-time passcode)
4441

45-
### Template Events
42+
### Workspace Events
4643

47-
These notifications are sent to users with **template admin** roles:
44+
These notifications are sent to the workspace owner:
4845

49-
- Template deleted
50-
- Template deprecated
46+
- Workspace automatic build failure
47+
- Workspace created
48+
- Workspace deleted
49+
- Workspace manual build failure
50+
- Workspace manually updated
51+
- Workspace marked as dormant
52+
- Workspace marked for deletion
5153
- Out of memory (OOM) / Out of disk (OOD)
52-
- [Configure](#configure-oomood-notifications) in the template `main.tf`.
53-
- Report: Workspace builds failed for template
54-
- This notification is delivered as part of a weekly cron job and summarizes
55-
the failed builds for a given template.
54+
- Template admins can [configure OOM/OOD](#configure-oomood-notifications) notifications in the template `main.tf`.
55+
- Workspace automatically updated
56+
57+
## Delivery Methods
58+
59+
Notifications can be delivered in the Coder dashboard and by SMTP or webhook.
60+
OOM/OOD notifications can be delivered to users in VS Code.
61+
62+
You can choose SMTP or webhook globally with
63+
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
64+
(default: `smtp`).
65+
When there are no delivery methods configured, notifications are disabled.
66+
67+
Premium customers can configure which method to use for each of the supported
68+
[Events](#workspace-events).
69+
See the [Preferences](#delivery-preferences) section for more details.
5670

5771
## Configuration
5872

59-
You can modify the notification delivery behavior using the following server
60-
flags.
73+
You can modify the notification delivery behavior in your Coder deployment's
74+
`https://coder.example.com/deployment/notifications`, or with the following server flags:
6175

6276
| Required | CLI | Env | Type | Description | Default |
6377
|:--------:|-------------------------------------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------|---------|
@@ -75,18 +89,6 @@ This can help prevent agent disconnects due to OOM/OOD issues.
7589
To enable OOM/OOD notifications on a template, follow the steps in the
7690
[resource monitoring guide](../../templates/extending-templates/resource-monitoring.md).
7791

78-
## Delivery Methods
79-
80-
Notifications can currently be delivered by either SMTP or webhook. Each message
81-
can only be delivered to one method, and this method is configured globally with
82-
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
83-
(default: `smtp`). When there are no delivery methods configured, notifications
84-
will be disabled.
85-
86-
Premium customers can configure which method to use for each of the supported
87-
[Events](#workspace-events); see the [Preferences](#delivery-preferences)
88-
section below for more details.
89-
9092
## SMTP (Email)
9193

9294
Use the `smtp` method to deliver notifications by email to your users. Coder

0 commit comments

Comments
 (0)