From 2a5bf85303996800ee662efec1a91d942797deaa Mon Sep 17 00:00:00 2001 From: Stephen Kirby Date: Mon, 10 Feb 2025 18:36:36 +0000 Subject: [PATCH 1/2] updated list of events in notification docs --- docs/admin/monitoring/notifications/index.md | 36 ++++++++++++-------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/admin/monitoring/notifications/index.md b/docs/admin/monitoring/notifications/index.md index a7eeab44d4b79..f9ff399133d2d 100644 --- a/docs/admin/monitoring/notifications/index.md +++ b/docs/admin/monitoring/notifications/index.md @@ -12,34 +12,40 @@ user(s) of this event. Currently we support the following list of events: _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._ -- 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._ -- 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._ -- Template Deleted +- Template deleted +- Template deprecated +- Report: Workspace builds failed for template + > This notification delivers on a weekly CRON summarizing the failed builds for a given template. + +Available events may differ between versions. See all events under `https://your-domain.com/deployment/notifications`. ## Configuration From c2ee5e13ac062cf7f0e4ec3f796e64343b9fd4d7 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 10 Feb 2025 20:31:20 +0000 Subject: [PATCH 2/2] md edit --- docs/admin/monitoring/notifications/index.md | 21 ++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/admin/monitoring/notifications/index.md b/docs/admin/monitoring/notifications/index.md index f9ff399133d2d..eb077e13b38ed 100644 --- a/docs/admin/monitoring/notifications/index.md +++ b/docs/admin/monitoring/notifications/index.md @@ -3,14 +3,20 @@ 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 created - Workspace deleted @@ -23,14 +29,14 @@ _These notifications are sent to the workspace owner._ ### 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 -_These notifications are sent to the user themselves._ +These notifications sent to users themselves: - User account suspended - User account activated @@ -38,14 +44,13 @@ _These notifications are sent to the user themselves._ ### 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 deprecated - Report: Workspace builds failed for template - > This notification delivers on a weekly CRON summarizing the failed builds for a given template. - -Available events may differ between versions. See all events under `https://your-domain.com/deployment/notifications`. + - This notification is delivered as part of a weekly cron job and summarizes + the failed builds for a given template. ## Configuration