diff options
Diffstat (limited to 'integrations/cloud-notifications/integrations/webhook.md')
| -rw-r--r-- | integrations/cloud-notifications/integrations/webhook.md | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/integrations/cloud-notifications/integrations/webhook.md b/integrations/cloud-notifications/integrations/webhook.md index 7e3aaea25f..8d177f0cbe 100644 --- a/integrations/cloud-notifications/integrations/webhook.md +++ b/integrations/cloud-notifications/integrations/webhook.md @@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Pro** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have an app that allows you to receive webhooks following a predefined schema. ### Netdata Configuration Steps @@ -55,9 +55,9 @@ From the Netdata Cloud UI, you can manage your space's notification settings and 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. - Netdata webhook integration service will send alert notifications to the destination service as soon as they are detected. + Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected. - The notification content sent to the destination service will be a JSON object having these properties: + For alert notifications, the content sent to the destination service contains a JSON object with the following properties: | field | type | description | | :-- | :-- | :-- | @@ -77,6 +77,18 @@ From the Netdata Cloud UI, you can manage your space's notification settings and | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. | | alarm_url | string | Netdata Cloud URL for this alarm. | + For reachability notifications, the JSON object will contain the following properties: + + | field | type | description | + | :-- | :-- | :-- | + | message | string | A summary message of the reachability alert. | + | url | string | Netdata Cloud URL for the host experiencing the reachability alert. | + | host | string | the host experiencing the reachability alert. | + | severity | string | severity for this notification. If host is reachable, severity will be 'info', if host is unreachable, it will be 'critical'. | + | status | object | an object with the status information. | + | status.reachable | boolean | true if host is reachable, false otherwise | + | status.text | string | can be 'reachable' or 'unreachable' | + #### Extra headers 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. |