From ccb0e1df305db387191e48e5fe2d3693d3b7c7b0 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Tue, 6 Jan 2026 12:54:46 +0000 Subject: [PATCH 1/2] GitBook: No commit message --- settings/notifications/webhook.md | 62 +++++++++++++++++-------------- 1 file changed, 34 insertions(+), 28 deletions(-) diff --git a/settings/notifications/webhook.md b/settings/notifications/webhook.md index a588d9a..dde0bd1 100644 --- a/settings/notifications/webhook.md +++ b/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" %} +``` +{ + "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 -
NameDescription
on every scheduled speedtest runOn each successful scheduled speedtest a notification will be send to the application.
on threshold failures for scheduled speedtestsOn any absolute threshold failure for scheduled speedtest a notification will be send to the application.
+
NameDescription
on every scheduled speedtest runOn each successful scheduled speedtest a notification will be send to the application.
on threshold failures for scheduled speedtestsOn any absolute threshold failure for scheduled speedtest a notification will be send to the application.
From 9318cb56db6942c6624eaabd6fa38f60fa4d5973 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Tue, 6 Jan 2026 12:55:33 +0000 Subject: [PATCH 2/2] GitBook: No commit message --- settings/notifications/webhook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings/notifications/webhook.md b/settings/notifications/webhook.md index dde0bd1..8bb7ab3 100644 --- a/settings/notifications/webhook.md +++ b/settings/notifications/webhook.md @@ -46,7 +46,7 @@ A webhook will send a JSON payload to a receiver of your choice {% endtab %} {% tab title="Completed test" %} -``` +```json { "result_id": 17, "site_name": "Speedtest Tracker",