chore(docs): update list of events in notification docs (#16516)

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Stephen Kirby
2025-02-13 14:42:28 -06:00
committed by GitHub
parent 00e76b881f
commit 766c05cfc6

View File

@ -3,43 +3,54 @@
Notifications are sent by Coder in response to specific internal events, such as Notifications are sent by Coder in response to specific internal events, such as
a workspace being deleted or a user being created. a workspace being deleted or a user being created.
Available events may differ between versions.
For a list of all events, visit your Coder deployment's
`https://coder.example.com/deployment/notifications`.
## Event Types ## Event Types
Notifications are sent in response to internal events, to alert the affected Notifications are sent in response to internal events, to alert the affected
user(s) of this event. Currently we support the following list of events: user(s) of the event.
Coder supports the following list of events:
### Workspace Events ### Workspace Events
_These notifications are sent to the workspace owner._ These notifications are sent to the workspace owner:
- Workspace Deleted - Workspace created
- Workspace Manual Build Failure - Workspace deleted
- Workspace Automatic Build Failure - Workspace manual build failure
- Workspace Automatically Updated - Workspace automatic build failure
- Workspace Dormant - Workspace manually updated
- Workspace Marked For Deletion - Workspace automatically updated
- Workspace marked as dormant
- Workspace marked for deletion
### User Events ### User Events
_These notifications are sent to users with **owner** and **user admin** roles._ These notifications sent to users with **owner** and **user admin** roles:
- User Account Created - User account created
- User Account Deleted - User account deleted
- User Account Suspended - User account suspended
- User Account Activated - User account activated
- _(coming soon) User Password Reset_
- _(coming soon) User Email Verification_
_These notifications are sent to the user themselves._ These notifications sent to users themselves:
- User Account Suspended - User account suspended
- User Account Activated - User account activated
- User password reset (One-time passcode)
### Template Events ### Template Events
_These notifications are sent to users with **template admin** roles._ These notifications are sent to users with **template admin** roles:
- Template Deleted - Template deleted
- Template deprecated
- Report: Workspace builds failed for template
- This notification is delivered as part of a weekly cron job and summarizes
the failed builds for a given template.
## Configuration ## Configuration