GITBOOK-1: No subject

Author: svenvg93

.gitbook/assets/apprise_notification.png

@@ -32,9 +32,10 @@
 * [Data Integrations](settings/data-platforms/README.md)
   * [InfluxDB v2](settings/data-platforms/influxdb2.md)
 * [Notifications](settings/notifications/README.md)
+  * [Apprise](settings/notifications/apprise.md)
   * [Database](settings/notifications/database.md)
   * [Mail](settings/notifications/mail.md)
-  * [Telegram](settings/notifications/telegram.md)
+  * [Webhook](settings/notifications/webhook.md)
 
 ## 👀 Other
 

.gitbook/assets/db_notification.png

@@ -1,30 +1,30 @@
 # Speedtest Process
 
-Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/cli) client to execute the speedtest. There a couple of stages the Speedtest Tracker goes through, below explains the process. 
+Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/cli) client to execute the speedtest. There a couple of stages the Speedtest Tracker goes through, below explains the process.
 
 {% stepper %}
 {% step %}
-### Started
+#### Started
 
 The Speedtest process is started
 {% endstep %}
 
 {% step %}
-### Checking
+#### Checking
 
 The application checks for an internet connection by calling `https://icanhazip.com`
 {% endstep %}
 
 {% step %}
-### Skipped \[Optional]
+#### Skipped \[Optional]
 
-If you have the `SPEEDTEST_SKIP_IPS`  the test will be marked as skipped as the IP returning during `Checking`  matches your defined IP.
+If you have the `SPEEDTEST_SKIP_IPS` the test will be marked as skipped as the IP returning during `Checking` matches your defined IP.
 {% endstep %}
 
 {% step %}
-### Running
+#### Running
 
-The application runs the speedtest by simply running the speedtest command. This command runs the speedtest like another other speedtest and returns the result in json format so the application an easily process it. 
+The application runs the speedtest by simply running the speedtest command. This command runs the speedtest like another other speedtest and returns the result in json format so the application an easily process it.
 
 ```
 speedtest -accept-license --accept-gdpr --format=json
@@ -38,20 +38,20 @@ speedtest -accept-license --accept-gdpr --format=json --server-id=YOURSERVERID
 {% endstep %}
 
 {% step %}
-### Failed
+#### Failed
 
-If for various reasons the Ookla CLI returns an error, because the defined server was offline for example the tests is marked as failed. As well when the `Checking` stage fails when there is no internet. 
+If for various reasons the Ookla CLI returns an error, because the defined server was offline for example the tests is marked as failed. As well when the `Checking` stage fails when there is no internet.
 {% endstep %}
 
 {% step %}
-### Benchmarking
+#### Benchmarking
 
 When you have thresholds set this step will evaluate the results against the threshold to determine if the test was healthy or not.
 {% endstep %}
 
 {% step %}
-### Completed
+#### Completed
 
-This is the end stage of the process when every step is completed the test is marked as such. 
+This is the end stage of the process when every step is completed the test is marked as such.
 {% endstep %}
 {% endstepper %}

.gitbook/assets/mail_notification.png

@@ -0,0 +1,18 @@
+# Apprise
+
+Speedtest Tracker uses [Apprise](https://github.com/caronc/apprise-api) to send notifications to a wide variety of messaging services with a simple, unified configuration.
+
+Apprise allows you to easily deliver alerts to popular platforms such as Discord, Slack, Telegram  and many more.
+
+{% hint style="warning" %}
+To use Apprise notifications, you must deploy the [Apprise API](https://github.com/caronc/apprise-api) service. This is out of scope of this documentation.
+{% endhint %}
+
+<figure><img src="../../.gitbook/assets/apprise_notification.png" alt=""><figcaption><p>Apprise Settings</p></figcaption></figure>
+
+<table><thead><tr><th width="200">Name</th><th width="535">Description</th></tr></thead><tbody><tr><td>URL</td><td>This is the URL of your running Apprise API instance </td></tr><tr><td>Service URL</td><td>This is the URL of the service that will receive the notification. You can find a full list of supported services and how to format their URLs in the <a href="https://github.com/caronc/apprise/wiki#notification-services">Apprise notification services documentation</a>.</td></tr></tbody></table>
+
+### Triggers
+
+<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>On completed speedtest</td><td>On each successful speedtest a notification will be send to the application.</td></tr><tr><td>On absolute threshold failure</td><td>On any absolute threshold failure a notification will be send to the application.</td></tr></tbody></table>
+

.gitbook/assets/webhook_notification.png

@@ -0,0 +1,62 @@
+# Webhook
+
+A webhook will send a JSON payload to a receiver of your choice
+
+<figure><img src="../../.gitbook/assets/webhook_notification.png" alt=""><figcaption><p>Webhook settings</p></figcaption></figure>
+
+### Payload
+
+Payload sent for a completed test
+
+```json
+{
+  "result_id": 2,
+  "site_name": "Speedtest Tracker",
+  "service": "Ookla",
+  "serverName": "Speedtest",
+  "serverId": 12345,
+  "isp": "Speedtest Communications",
+  "ping": 6.7,
+  "download": 93281280,
+  "upload": 28769728,
+  "packetLoss": 0,
+  "speedtest_url": "https://docs.speedtest-tracker.dev",
+  "url": "http://localhost/admin/results"
+}
+```
+
+Payload sent for a threshold failure
+
+```json
+{
+  "result_id": 8,
+  "site_name": "Speedtest Tracker",
+  "service": "Ookla",
+  "serverName": "Speedtest",
+  "serverId": 12345,
+  "isp": "Speedtest Communications",
+  "metrics": [
+    {
+      "name": "Download",
+      "threshold": "1000 Mbps",
+      "value": "91.78 Mbps"
+    },
+    {
+      "name": "Upload",
+      "threshold": "1000 Mbps",
+      "value": "28.18 Mbps"
+    },
+    {
+      "name": "Ping",
+      "threshold": "2 ms",
+      "value": "6.41 ms"
+    }
+  ],
+  "speedtest_url": "https://docs.speedtest-tracker.dev",
+  "url": "http://localhost/admin/results"
+}
+```
+
+### Triggers
+
+<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>On completed speedtest</td><td>On each successful speedtest a notification will be send to the application.</td></tr><tr><td>On absolute threshold failure</td><td>On any absolute threshold failure a notification will be send to the application.</td></tr></tbody></table>