|
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 |
| -## Enable experiment |
7 |
| - |
8 |
| -In order to activate the notifications feature on Coder v2.15.X, you'll need to |
9 |
| -enable the `notifications` experiment. Notifications are enabled by default |
10 |
| -starting in v2.16.0. |
11 |
| - |
12 |
| -```bash |
13 |
| -# Using the CLI flag |
14 |
| -$ coder server --experiments=notifications |
15 |
| - |
16 |
| -# Alternatively, using the `CODER_EXPERIMENTS` environment variable |
17 |
| -$ CODER_EXPERIMENTS=notifications coder server |
18 |
| -``` |
19 |
| - |
20 |
| -More information on experiments can be found |
21 |
| -[here](https://coder.com/docs/contributing/feature-stages#experimental-features). |
22 |
| - |
23 | 6 | ## Event Types
|
24 | 7 |
|
25 | 8 | Notifications are sent in response to internal events, to alert the affected
|
@@ -171,33 +154,33 @@ Here is an example payload for Coder's webhook notification:
|
171 | 154 |
|
172 | 155 | ```json
|
173 | 156 | {
|
174 |
| - "_version": "1.0", |
175 |
| - "msg_id": "88750cad-77d4-4663-8bc0-f46855f5019b", |
176 |
| - "payload": { |
177 |
| - "_version": "1.0", |
178 |
| - "notification_name": "Workspace Deleted", |
179 |
| - "user_id": "4ac34fcb-8155-44d5-8301-e3cd46e88b35", |
180 |
| - "user_email": "danny@coder.com", |
181 |
| - "user_name": "danny", |
182 |
| - "user_username": "danny", |
183 |
| - "actions": [ |
184 |
| - { |
185 |
| - "label": "View workspaces", |
186 |
| - "url": "https://et23ntkhpueak.pit-1.try.coder.app/workspaces" |
187 |
| - }, |
188 |
| - { |
189 |
| - "label": "View templates", |
190 |
| - "url": "https://et23ntkhpueak.pit-1.try.coder.app/templates" |
191 |
| - } |
192 |
| - ], |
193 |
| - "labels": { |
194 |
| - "initiator": "danny", |
195 |
| - "name": "my-workspace", |
196 |
| - "reason": "initiated by user" |
197 |
| - } |
198 |
| - }, |
199 |
| - "title": "Workspace \"my-workspace\" deleted", |
200 |
| - "body": "Hi danny\n\nYour workspace my-workspace was deleted.\nThe specified reason was \"initiated by user (danny)\"." |
| 157 | + "_version": "1.0", |
| 158 | + "msg_id": "88750cad-77d4-4663-8bc0-f46855f5019b", |
| 159 | + "payload": { |
| 160 | + "_version": "1.0", |
| 161 | + "notification_name": "Workspace Deleted", |
| 162 | + "user_id": "4ac34fcb-8155-44d5-8301-e3cd46e88b35", |
| 163 | + "user_email": "danny@coder.com", |
| 164 | + "user_name": "danny", |
| 165 | + "user_username": "danny", |
| 166 | + "actions": [ |
| 167 | + { |
| 168 | + "label": "View workspaces", |
| 169 | + "url": "https://et23ntkhpueak.pit-1.try.coder.app/workspaces" |
| 170 | + }, |
| 171 | + { |
| 172 | + "label": "View templates", |
| 173 | + "url": "https://et23ntkhpueak.pit-1.try.coder.app/templates" |
| 174 | + } |
| 175 | + ], |
| 176 | + "labels": { |
| 177 | + "initiator": "danny", |
| 178 | + "name": "my-workspace", |
| 179 | + "reason": "initiated by user" |
| 180 | + } |
| 181 | + }, |
| 182 | + "title": "Workspace \"my-workspace\" deleted", |
| 183 | + "body": "Hi danny\n\nYour workspace my-workspace was deleted.\nThe specified reason was \"initiated by user (danny)\"." |
201 | 184 | }
|
202 | 185 | ```
|
203 | 186 |
|
@@ -267,12 +250,16 @@ To resume sending notifications, execute
|
267 | 250 | If notifications are not being delivered, use the following methods to
|
268 | 251 | troubleshoot:
|
269 | 252 |
|
270 |
| -1. Ensure notifications are being added to the `notification_messages` table |
271 |
| -2. Review any error messages in the `status_reason` column, should an error have |
272 |
| - occurred |
273 |
| -3. Review the logs (search for the term `notifications`) for diagnostic |
274 |
| - information<br> _If you do not see any relevant logs, set |
275 |
| - `CODER_VERBOSE=true` or `--verbose` to output debug logs_ |
| 253 | +1. Ensure notifications are being added to the `notification_messages` table |
| 254 | +2. Review any error messages in the `status_reason` column, should an error |
| 255 | + have occurred |
| 256 | +3. Review the logs (search for the term `notifications`) for diagnostic |
| 257 | + information<br> _If you do not see any relevant logs, set |
| 258 | + `CODER_VERBOSE=true` or `--verbose` to output debug logs_ |
| 259 | +4. If you are on version 2.15.x, notifications must be enabled using the |
| 260 | + `notifications` |
| 261 | + [experiment](https://coder.com/docs/contributing/feature-stages#experimental-features). |
| 262 | + Notifications are enabled by default starting in v2.16.0. |
276 | 263 |
|
277 | 264 | ## Internals
|
278 | 265 |
|
|
0 commit comments