7a9f81f8c · cryptotaxi247/netdata-1

@@ -14,63 +14,34 @@

14 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord."

15 notification_limitations: ''

16 setup:

17 - prerequisites:

18 - list:

19 - - title: 'Netdata Access'

20 - description: |

21 - - A Netdata Cloud account

22 - - Access to the Netdata Space as an **administrator**

23 - - title: 'Discord Server Configuration'

24 - description: |

25 - You need to have a Discord server able to receive [webhooks integrations](https://support.discord.com/hc/en-us/articles/228383668).

26 - Steps to configure your Discord server to receive notifications from Netdata:

27 -

28 - 1. Go to `Server Settings` --> `Integrations`

29 - 2. **Create Webhook** or **View Webhooks** if you already have some defined

30 - 3. Specify the **Name** and **Channel** on your new webhook

31 - 4. Use Webhook URL to add your notification configuration on Netdata UI

32 -

33 - configuration:

34 - description: |

35 - ## Configuration Steps:

36 -

37 - 1. Click on the **Space settings** cog (located above your profile icon)

38 - 2. Click on the **Notification** tab

39 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

40 - 4. On the **Discord** card click on **+ Add**

41 - 5. A modal will be presented to you to enter the required details to enable the configuration:

42 - * **Notification settings** are Netdata specific settings

43 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

44 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

45 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

46 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:

47 - - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**

48 - - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.

49 - - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well

50 -

51 - file:

52 - name: ''

53 - description: ''

54 - options:

55 - description: ''

56 - folding:

57 - title: ''

58 - enabled: true

59 - list:

60 - - name: ''

61 - default_value: ''

62 - description: ''

63 - required: false

64 - examples:

65 - folding:

66 - enabled: true

67 - title: ''

68 - list:

69 - - name: ''

70 - folding:

71 - enabled: false

72 - description: ''

73 - config: ''

17 + description: |

18 + ### Prerequisites

19 + - A Netdata Cloud account

20 + - Access to the Netdata Space as an **administrator**

21 + - You need to have a Discord server able to receive webhooks integrations.

22 +

23 + ### Discord Server Configuration

24 + Steps to configure your Discord server to receive [webhook notifications](https://support.discord.com/hc/en-us/articles/228383668) from Netdata:

25 + 1. Go to `Server Settings` --> `Integrations`

26 + 2. **Create Webhook** or **View Webhooks** if you already have some defined

27 + 3. Specify the **Name** and **Channel** on your new webhook

28 + 4. Use Webhook URL to add your notification configuration on Netdata UI

29 +

30 + ### Netdata Configuration Steps

31 + 1. Click on the **Space settings** cog (located above your profile icon)

32 + 2. Click on the **Notification** tab

33 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

34 + 4. On the **Discord** card click on **+ Add**

35 + 5. A modal will be presented to you to enter the required details to enable the configuration:

36 + * **Notification settings** are Netdata specific settings

37 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

38 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

39 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

40 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:

41 + - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**

42 + - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.

43 + - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well

44 +

45 - id: 'notify-pagerduty'

46 meta:

47 name: 'PagerDuty'

@@ -84,61 +55,35 @@

55 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on PagerDuty."

56 notification_limitations: ''

57 setup:

87 - prerequisites:

88 - list:

89 - - title: 'Netdata Access'

90 - description: |

91 - - A Netdata Cloud account

92 - - Access to the Netdata Space as an **administrator**

93 - - The Netdata Space needs to be on **Business** plan or higher

94 - - title: 'Discord Server Configuration'

95 - description: |

96 - You need to have a PagerDuty service to receive events using webhooks.

97 - Steps to configure your PagerDuty to receive notifications from Netdata:

98 -

99 - 1. Create a service to receive events from your services directory page on PagerDuty

100 - 2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined

101 - 3. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI.

102 -

103 -

104 - configuration:

105 - description: |

106 - ## Configuration Steps

107 -

108 - 1. Click on the **Space settings** cog (located above your profile icon)

109 - 2. Click on the **Notification** tab

110 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

111 - 4. On the **PagerDuty** card click on **+ Add**

112 - 5. A modal will be presented to you to enter the required details to enable the configuration:

113 - * **Notification settings** are Netdata specific settings

114 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

115 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

116 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

117 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:

118 - - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.

119 - file:

120 - name: ''

121 - description: ''

122 - options:

123 - description: ''

124 - folding:

125 - title: ''

126 - enabled: true

127 - list:

128 - - name: ''

129 - default_value: ''

130 - description: ''

131 - required: false

132 - examples:

133 - folding:

134 - enabled: true

135 - title: ''

136 - list:

137 - - name: ''

138 - folding:

139 - enabled: false

140 - description: ''

141 - config: ''

58 + description: |

59 + ### Prerequisites

60 + - A Netdata Cloud account

61 + - Access to the Netdata Space as an **administrator**

62 + - The Netdata Space needs to be on **Business** plan or higher

63 + - You need to have a PagerDuty service to receive events using webhooks.

64 +

65 +

66 + ### PagerDuty Server Configuration

67 + Steps to configure your PagerDuty to receive notifications from Netdata:

68 +

69 + 1. Create a service to receive events from your services directory page on PagerDuty

70 + 2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined

71 + 3. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI.

72 +

73 + ### Netdata Configuration Steps

74 +

75 + 1. Click on the **Space settings** cog (located above your profile icon)

76 + 2. Click on the **Notification** tab

77 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

78 + 4. On the **PagerDuty** card click on **+ Add**

79 + 5. A modal will be presented to you to enter the required details to enable the configuration:

80 + * **Notification settings** are Netdata specific settings

81 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

82 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

83 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

84 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:

85 + - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.

86 +

87 - id: 'notify-slack'

88 meta:

89 name: 'Slack'

@@ -152,67 +97,42 @@

97 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Slack."

98 notification_limitations: ''

99 setup:

155 - prerequisites:

156 - list:

157 - - title: 'Netdata Access'

158 - description: |

159 - - A Netdata Cloud account

160 - - Access to the Netdata Space as an **administrator**

161 - - The Netdata Space needs to be on **Business** plan or higher

162 - - title: 'Slack Server Configuration'

163 - description: |

164 - You need to have a Slack app on your workspace to receive the Webhooks.

165 - Steps to configure your Slack to receive notifications from Netdata:

166 -

167 - 1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details

168 - 2. Install the app on your workspace

169 - 3. Configure Webhook URLs for your workspace

170 - - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**

171 - - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**

172 - - After pressing that specify the channel where you want your notifications to be delivered

173 - - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI

174 -

175 - For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).

176 -

177 - configuration:

178 - description: |

179 - ## Configuration Steps

180 -

181 - 1. Click on the **Space settings** cog (located above your profile icon)

182 - 2. Click on the **Notification** tab

183 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

184 - 4. On the **Slack** card click on **+ Add**

185 - 5. A modal will be presented to you to enter the required details to enable the configuration:

186 - * **Notification settings** are Netdata specific settings

187 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

188 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

189 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

190 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:

191 - - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.

192 -

193 - file:

194 - name: ''

195 - description: ''

196 - options:

197 - description: ''

198 - folding:

199 - title: ''

200 - enabled: true

201 - list:

202 - - name: ''

203 - default_value: ''

204 - description: ''

205 - required: false

206 - examples:

207 - folding:

208 - enabled: true

209 - title: ''

210 - list:

211 - - name: ''

212 - folding:

213 - enabled: false

214 - description: ''

215 - config: ''

100 + description: |

101 + ### Prerequisites

102 +

103 + - A Netdata Cloud account

104 + - Access to the Netdata Space as an **administrator**

105 + - The Netdata Space needs to be on **Business** plan or higher

106 + - You need to have a Slack app on your workspace to receive the Webhooks.

107 +

108 + ### Slack Server Configuration

109 +

110 + Steps to configure your Slack to receive notifications from Netdata:

111 +

112 + 1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details

113 + 2. Install the app on your workspace

114 + 3. Configure Webhook URLs for your workspace

115 + - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**

116 + - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**

117 + - After pressing that specify the channel where you want your notifications to be delivered

118 + - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI

119 +

120 + For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).

121 +

122 + ### Netdata Configuration Steps

123 +

124 + 1. Click on the **Space settings** cog (located above your profile icon)

125 + 2. Click on the **Notification** tab

126 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

127 + 4. On the **Slack** card click on **+ Add**

128 + 5. A modal will be presented to you to enter the required details to enable the configuration:

129 + * **Notification settings** are Netdata specific settings

130 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

131 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

132 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

133 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:

134 + - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.

135 +

136 - id: 'notify-opsgenie'

137 meta:

138 name: 'Opsgenie'

@@ -227,60 +147,36 @@

147 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie."

148 notification_limitations: ''

149 setup:

230 - prerequisites:

231 - list:

232 - - title: 'Netdata Access'

233 - description: |

234 - - A Netdata Cloud account

235 - - Access to the Netdata Space as an **administrator**

236 - - The Netdata Space needs to be on **Business** plan or higher

237 - - title: 'Opsgenie Configuration'

238 - description: |

239 - You need to have permissions on Opsgenie to add new integrations.

240 - Steps to configure your Opsgenie to receive notifications from Netdata:

241 -

242 - 1. Go to integrations tab of your team, click **Add integration**

243 - 2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.

244 - 3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.

245 -

246 - configuration:

247 - description: |

248 - ## Configuration Steps

249 -

250 - 1. Click on the **Space settings** cog (located above your profile icon)

251 - 2. Click on the **Notification** tab

252 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

253 - 4. On the **Opsgenie** card click on **+ Add**

254 - 5. A modal will be presented to you to enter the required details to enable the configuration:

255 - * **Notification settings** are Netdata specific settings

256 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

257 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

258 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

259 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:

260 - - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.

261 - file:

262 - name: ''

263 - description: ''

264 - options:

265 - description: ''

266 - folding:

267 - title: ''

268 - enabled: true

269 - list:

270 - - name: ''

271 - default_value: ''

272 - description: ''

273 - required: false

274 - examples:

275 - folding:

276 - enabled: true

277 - title: ''

278 - list:

279 - - name: ''

280 - folding:

281 - enabled: false

282 - description: ''

283 - config: ''

150 + description: |

151 + ### Prerequisites

152 +

153 + - A Netdata Cloud account

154 + - Access to the Netdata Space as an **administrator**

155 + - The Netdata Space needs to be on **Business** plan or higher

156 + - You need to have permissions on Opsgenie to add new integrations.

157 +

158 + ### Opsgenie Server Configuration

159 +

160 + Steps to configure your Opsgenie to receive notifications from Netdata:

161 +

162 + 1. Go to integrations tab of your team, click **Add integration**

163 + 2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.

164 + 3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.

165 +

166 + ### Netdata Configuration Steps

167 +

168 + 1. Click on the **Space settings** cog (located above your profile icon)

169 + 2. Click on the **Notification** tab

170 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

171 + 4. On the **Opsgenie** card click on **+ Add**

172 + 5. A modal will be presented to you to enter the required details to enable the configuration:

173 + * **Notification settings** are Netdata specific settings

174 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

175 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

176 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

177 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:

178 + - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.

179 +

180 - id: 'notify-mattermost'

181 meta:

182 name: 'Mattermost'

@@ -294,67 +190,44 @@

190 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Mattermost."

191 notification_limitations: ''

192 setup:

297 - prerequisites:

298 - list:

299 - - title: 'Netdata Access'

300 - description: |

301 - - A Netdata Cloud account

302 - - Access to the Netdata Space as an **administrator**

303 - - The Netdata Space needs to be on **Business** plan or higher

304 - - title: 'Mattermost Configuration'

305 - description: |

306 - You need to have a Mattermost app on your workspace to receive the webhooks.

307 - Steps to configure your Mattermost to receive notifications from Netdata:

308 -

309 - 1. In Mattermost, go to Product menu > Integrations > Incoming Webhook

310 - - If you don’t have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.

311 - 2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters

312 - 3. Select the channel to receive webhook payloads, then select Add to create the webhook

313 - 4. You will end up with a webhook endpoint that looks like below:

314 - `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`

315 -

316 - - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.

193 + description: |

194 + ### Prerequisites

195 +

196 + - A Netdata Cloud account

197 + - Access to the Netdata Space as an **administrator**

198 + - The Netdata Space needs to be on **Business** plan or higher

199 + - You need to have permissions on Mattermost to add new integrations.

200 + - You need to have a Mattermost app on your workspace to receive the webhooks.

201 +

202 + ### Mattermost Server Configuration

203 +

204 + Steps to configure your Mattermost to receive notifications from Netdata:

205 +

206 + 1. In Mattermost, go to Product menu > Integrations > Incoming Webhook

207 + - If you don’t have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.

208 + 2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters

209 + 3. Select the channel to receive webhook payloads, then select Add to create the webhook

210 + 4. You will end up with a webhook endpoint that looks like below:

211 + `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`

212 +

213 + - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.

214

318 - For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).

319 -

320 - configuration:

321 - description: |

322 - ## Configuration Steps

323 -

324 - 1. Click on the **Space settings** cog (located above your profile icon)

325 - 2. Click on the **Notification** tab

326 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

327 - 4. On the **Mattermost** card click on **+ Add**

328 - 5. A modal will be presented to you to enter the required details to enable the configuration:

329 - * **Notification settings** are Netdata specific settings

330 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

331 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

332 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

333 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:

334 - - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications

335 - file:

336 - name: ''

337 - description: ''

338 - options:

339 - description: ''

340 - folding:

341 - title: ''

342 - enabled: true

343 - list:

344 - - name: ''

345 - default_value: ''

346 - description: ''

347 - required: false

348 - examples:

349 - folding:

350 - enabled: true

351 - title: ''

352 - list:

353 - - name: ''

354 - folding:

355 - enabled: false

356 - description: ''

357 - config: ''

215 + For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).

216 +

217 + ### Netdata Configuration Steps

218 +

219 + 1. Click on the **Space settings** cog (located above your profile icon)

220 + 2. Click on the **Notification** tab

221 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

222 + 4. On the **Mattermost** card click on **+ Add**

223 + 5. A modal will be presented to you to enter the required details to enable the configuration:

224 + * **Notification settings** are Netdata specific settings

225 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

226 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

227 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

228 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:

229 + - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications

230 +

231 - id: 'notify-rocketchat'

232 meta:

233 name: 'RocketChat'

@@ -368,68 +241,44 @@

241 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on RocketChat."

242 notification_limitations: ''

243 setup:

371 - prerequisites:

372 - list:

373 - - title: 'Netdata Access'

374 - description: |

375 - - A Netdata Cloud account

376 - - Access to the Netdata Space as an **administrator**

377 - - The Netdata Space needs to be on **Business** plan or higher

378 - - title: 'RocketChat Configuration'

379 - description: |

380 - You need to have a RocketChat app on your workspace to receive the webhooks.

381 - Steps to configure your RocketChat to receive notifications from Netdata:

382 -

383 - 1. In RocketChat, Navigate to Administration > Workspace > Integrations.

384 - 2. Click **+New** at the top right corner.

385 - 3. For more details about each parameter, check [create-a-new-incoming-webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook).

386 - 4. After configuring integration, click Save.

387 - 5. You will end up with a webhook endpoint that looks like below:

388 - `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`

389 - - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance.

244 + description: |

245 + ### Prerequisites

246 +

247 + - A Netdata Cloud account

248 + - Access to the Netdata Space as an **administrator**

249 + - The Netdata Space needs to be on **Business** plan or higher

250 + - You need to have permissions on Mattermost to add new integrations.

251 + - You need to have a RocketChat app on your workspace to receive the webhooks.

252 +

253 + ### Mattermost Server Configuration

254 +

255 + Steps to configure your RocketChat to receive notifications from Netdata:

256 +

257 + 1. In RocketChat, Navigate to Administration > Workspace > Integrations.

258 + 2. Click **+New** at the top right corner.

259 + 3. For more details about each parameter, check [create-a-new-incoming-webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook).

260 + 4. After configuring integration, click Save.

261 + 5. You will end up with a webhook endpoint that looks like below:

262 + `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`

263 + - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance.

264

265

392 - For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).

393 -

394 -

395 - configuration:

396 - description: |

397 - ## Configuration Steps

398 -

399 - 1. Click on the **Space settings** cog (located above your profile icon)

400 - 2. Click on the **Notification** tab

401 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

402 - 4. On the **RocketChat** card click on **+ Add**

403 - 5. A modal will be presented to you to enter the required details to enable the configuration:

404 - * **Notification settings** are Netdata specific settings

405 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

406 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

407 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

408 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:

409 - - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.

410 - file:

411 - name: ''

412 - description: ''

413 - options:

414 - description: ''

415 - folding:

416 - title: ''

417 - enabled: true

418 - list:

419 - - name: ''

420 - default_value: ''

421 - description: ''

422 - required: false

423 - examples:

424 - folding:

425 - enabled: true

426 - title: ''

427 - list:

428 - - name: ''

429 - folding:

430 - enabled: false

431 - description: ''

432 - config: ''

266 + For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).

267 +

268 + ### Netdata Configuration Steps

269 +

270 + 1. Click on the **Space settings** cog (located above your profile icon)

271 + 2. Click on the **Notification** tab

272 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

273 + 4. On the **RocketChat** card click on **+ Add**

274 + 5. A modal will be presented to you to enter the required details to enable the configuration:

275 + * **Notification settings** are Netdata specific settings

276 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

277 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

278 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

279 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:

280 + - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.

281 +

282 - id: 'notify-webhook'

283 meta:

284 name: 'Webhook'

@@ -444,42 +293,39 @@

293 notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on a webhook using a predefined schema."

294 notification_limitations: ''

295 setup:

447 - prerequisites:

448 - list:

449 - - title: ''

450 - description: |

451 - - A Netdata Cloud account

452 - - Access to the Netdata Space as an **administrator**

453 - - The Netdata Space needs to be on **Pro** plan or higher

454 - - You need to have an app that allows you to receive webhooks following a predefined schema.

455 -

456 -

457 - configuration:

458 - description: |

459 - ## Configuration Steps

460 -

461 - 1. Click on the **Space settings** cog (located above your profile icon)

462 - 2. Click on the **Notification** tab

463 - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

464 - 4. On the **Mattermost** card click on **+ Add**

465 - 5. A modal will be presented to you to enter the required details to enable the configuration:

466 - * **Notification settings** are Netdata specific settings

467 - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

468 - - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

469 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

470 - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For webhook:

471 - - Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls.

472 - - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.

473 - - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms.

474 - * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.

475 - * Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.

476 - * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.

477 -

478 - ## Webhook service

296 + description: |

297 + ### Prerequisites

298 +

299 + - A Netdata Cloud account

300 + - Access to the Netdata Space as an **administrator**

301 + - The Netdata Space needs to be on **Pro** plan or higher

302 + - You need to have an app that allows you to receive webhooks following a predefined schema.

303 +

304 + ### Netdata Configuration Steps

305 +

306 + 1. Click on the **Space settings** cog (located above your profile icon)

307 + 2. Click on the **Notification** tab

308 + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)

309 + 4. On the **Webhook** card click on **+ Add**

310 + 5. A modal will be presented to you to enter the required details to enable the configuration:

311 + * **Notification settings** are Netdata specific settings

312 + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it

313 + - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration

314 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only

315 + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Webhook:

316 + - Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls.

317 + - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.

318 + - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms.

319 + * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.

320 + * Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.

321 + * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.

322 +

323 +

324 + ### Webhook service

325

326 A webhook integration allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. In this document, we'll go over the steps to set up a generic webhook integration, including adding headers, and implementing different types of authorization mechanisms.

327

482 - ### Netdata webhook integration

328 + #### Netdata webhook integration

329

330 A webhook integration is a way for one service to notify another service about events that occur within it. This is done by sending an HTTP POST request to a specified URL (known as the "webhook URL") when an event occurs.

331

@@ -505,7 +351,7 @@

351 | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |

352 | alarm_url | string | Netdata Cloud URL for this alarm. |

353

508 - ### Extra headers

354 + #### Extra headers

355

356 When setting up a webhook integration, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.

357

@@ -515,11 +361,11 @@

361 |:-------------------------------:|-----------------------------|

362 | Content-Type | application/json |

363

518 - ### Authentication mechanisms

364 + #### Authentication mechanisms

365

366 Netdata webhook integration supports 3 different authentication mechanisms:

367

522 - #### Mutual TLS authentication (recommended)

368 + ##### Mutual TLS authentication (recommended)

369

370 In mutual Transport Layer Security (mTLS) authentication, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients.

371

@@ -608,15 +454,15 @@

454 </Directory>

455 ```

456

611 - #### Basic authentication

457 + ##### Basic authentication

458

459 In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service.

460

615 - #### Bearer token authentication

461 + ##### Bearer token authentication

462

463 In bearer token authentication, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.

464

619 - ##### Challenge secret

465 + ###### Challenge secret

466

467 To validate that you has ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.

468

@@ -672,26 +518,3 @@

518 return json.dumps(response)

519 ```

520

675 - file:

676 - name: ''

677 - description: ''

678 - options:

679 - description: ''

680 - folding:

681 - title: ''

682 - enabled: true

683 - list:

684 - - name: ''

685 - default_value: ''

686 - description: ''

687 - required: false

688 - examples:

689 - folding:

690 - enabled: true

691 - title: ''

692 - list:

693 - - name: ''

694 - folding:

695 - enabled: false

696 - description: ''

697 - config: ''

Adapt Cloud notifications to the new schema (#15674)