Merge pull request #106 from svenvg93/2592-add-results-to-payload

Update webhook payloads

Author: alexjustesen

settings/notifications/webhook.md

@@ -6,59 +6,65 @@ A webhook will send a JSON payload to a receiver of your choice
 
 ### Payload
 
-Payload sent for a completed test
-
-```json
-{
-  "result_id": 1,
-  "site_name": "Speedtest Tracker",
-  "server_name": "Speedtest",
-  "server_id": 52365,
-  "isp": "Super Speed",
-  "ping": 2.782,
-  "download": 937874216,
-  "upload": 937797864,
-  "packet_loss": 0,
-  "speedtest_url": "https://www.speedtest.net/result/c/af8ddebf-7ef7-4b8d-b0c1-aaaaaaaaaaaa",
-  "url": "http://localhost/admin/results"
-}
-```
-
-Payload sent for a threshold failure
-
+{% tabs %}
+{% tab title="Threshold Failure " %}
 ```json
 {
-  "result_id": 1,
+  "result_id": 14,
   "site_name": "Speedtest Tracker",
-  "isp": "Super Speed",
+  "isp": "Speedy Communications",
   "benchmarks": {
     "download": {
       "bar": "min",
       "passed": false,
       "type": "absolute",
-      "value": 2000,
+      "test_value": 1022,
+      "benchmark_value": 2000,
       "unit": "mbps"
     },
     "upload": {
       "bar": "min",
       "passed": false,
       "type": "absolute",
-      "value": 2000,
+      "test_value": 1018,
+      "benchmark_value": 2000,
       "unit": "mbps"
     },
     "ping": {
       "bar": "max",
       "passed": false,
       "type": "absolute",
-      "value": 1,
+      "test_value": 3,
+      "benchmark_value": 1,
       "unit": "ms"
     }
   },
-  "speedtest_url": "https://www.speedtest.net/result/c/af8ddebf-7ef7-4b8d-b0c1-aaaaaaaaa",
-  "url": "http://localhost/admin/results"
+  "speedtest_url": "https://www.speedtest.net/result/c/1433a2de-eb3c-4a0e-ab29-xxxxxx",
+  "url": "http://192.168.1.5/admin/results"
+}
+```
+{% endtab %}
+
+{% tab title="Completed test" %}
+```json
+{
+  "result_id": 17,
+  "site_name": "Speedtest Tracker",
+  "server_name": "Speedtest",
+  "server_id": 52365,
+  "status": "completed",
+  "isp": "Speedy Communications",
+  "ping": 3,
+  "download": 1026,
+  "upload": 1012,
+  "packet_loss": 0,
+  "speedtest_url": "https://www.speedtest.net/result/c/288aa4aa-a52e-493c-8d60-xxxx",
+  "url": "http://192.168.1.5/admin/results"
 }
 ```
+{% endtab %}
+{% endtabs %}
 
 ### Triggers
 
-<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>on every scheduled speedtest run</td><td>On each successful scheduled speedtest a notification will be send to the application.</td></tr><tr><td>on threshold failures for scheduled speedtests</td><td>On any absolute threshold failure for scheduled speedtest  a notification will be send to the application.</td></tr></tbody></table>
+<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>on every scheduled speedtest run</td><td>On each successful scheduled speedtest a notification will be send to the application.</td></tr><tr><td>on threshold failures for scheduled speedtests</td><td>On any absolute threshold failure for scheduled speedtest a notification will be send to the application.</td></tr></tbody></table>