Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 13, 2025
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a5bf85
updated list of events in notification docs
stirby Feb 10, 2025
c2ee5e1
md edit
EdwardAngert Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 31 additions & 20 deletions docs/admin/monitoring/notifications/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,54 @@
Notifications are sent by Coder in response to specific internal events, such as
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

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

_These notifications are sent to the workspace owner._
These notifications are sent to the workspace owner:

- Workspace Deleted
- Workspace Manual Build Failure
- Workspace Automatic Build Failure
- Workspace Automatically Updated
- Workspace Dormant
- Workspace Marked For Deletion
- Workspace created
- Workspace deleted
- Workspace manual build failure
- Workspace automatic build failure
- Workspace manually updated
- Workspace automatically updated
- Workspace marked as dormant
- Workspace marked for deletion

### 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 Deleted
- User Account Suspended
- User Account Activated
- _(coming soon) User Password Reset_
- _(coming soon) User Email Verification_
- User account created
- User account deleted
- User account suspended
- User account activated

_These notifications are sent to the user themselves._
These notifications sent to users themselves:

- User Account Suspended
- User Account Activated
- User account suspended
- User account activated
- User password reset (One-time passcode)

### 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

Expand Down