From 766c05cfc638728744dd31e70b66b56e8f4f4490 Mon Sep 17 00:00:00 2001 From: Stephen Kirby <58410745+stirby@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:42:28 -0600 Subject: [PATCH] chore(docs): update list of events in notification docs (#16516) Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> --- docs/admin/monitoring/notifications/index.md | 51 ++++++++++++-------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/docs/admin/monitoring/notifications/index.md b/docs/admin/monitoring/notifications/index.md index a7eeab44d4..eb077e13b3 100644 --- a/docs/admin/monitoring/notifications/index.md +++ b/docs/admin/monitoring/notifications/index.md @@ -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