|
3 | 3 | Notifications are sent by Coder in response to specific internal events, such as |
4 | 4 | a workspace being deleted or a user being created. |
5 | 5 |
|
| 6 | +Available events may differ between versions. |
| 7 | +For a list of all events, visit your Coder deployment's |
| 8 | +`https://coder.example.com/deployment/notifications`. |
| 9 | + |
6 | 10 | ## Event Types |
7 | 11 |
|
8 | 12 | Notifications are sent in response to internal events, to alert the affected |
9 | | -user(s) of this event. Currently we support the following list of events: |
| 13 | +user(s) of the event. |
| 14 | + |
| 15 | +Coder supports the following list of events: |
10 | 16 |
|
11 | 17 | ### Workspace Events |
12 | 18 |
|
13 | | -_These notifications are sent to the workspace owner._ |
| 19 | +These notifications are sent to the workspace owner: |
14 | 20 |
|
15 | | -- Workspace Deleted |
16 | | -- Workspace Manual Build Failure |
17 | | -- Workspace Automatic Build Failure |
18 | | -- Workspace Automatically Updated |
19 | | -- Workspace Dormant |
20 | | -- Workspace Marked For Deletion |
| 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 | 29 |
|
22 | 30 | ### User Events |
23 | 31 |
|
24 | | -_These notifications are sent to users with **owner** and **user admin** roles._ |
| 32 | +These notifications sent to users with **owner** and **user admin** roles: |
25 | 33 |
|
26 | | -- User Account Created |
27 | | -- User Account Deleted |
28 | | -- User Account Suspended |
29 | | -- User Account Activated |
30 | | -- _(coming soon) User Password Reset_ |
31 | | -- _(coming soon) User Email Verification_ |
| 34 | +- User account created |
| 35 | +- User account deleted |
| 36 | +- User account suspended |
| 37 | +- User account activated |
32 | 38 |
|
33 | | -_These notifications are sent to the user themselves._ |
| 39 | +These notifications sent to users themselves: |
34 | 40 |
|
35 | | -- User Account Suspended |
36 | | -- User Account Activated |
| 41 | +- User account suspended |
| 42 | +- User account activated |
| 43 | +- User password reset (One-time passcode) |
37 | 44 |
|
38 | 45 | ### Template Events |
39 | 46 |
|
40 | | -_These notifications are sent to users with **template admin** roles._ |
| 47 | +These notifications are sent to users with **template admin** roles: |
41 | 48 |
|
42 | | -- Template Deleted |
| 49 | +- Template deleted |
| 50 | +- Template deprecated |
| 51 | +- Report: Workspace builds failed for template |
| 52 | + - This notification is delivered as part of a weekly cron job and summarizes |
| 53 | + the failed builds for a given template. |
43 | 54 |
|
44 | 55 | ## Configuration |
45 | 56 |
|
|
0 commit comments