Webhook

A webhook will send a JSON payload to a receiver of your choice

Webhook settings

Payload

Payload sent for a completed test

{
  "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

{
  "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

Name	Description
On completed speedtest	On each successful speedtest a notification will be send to the application.
On absolute threshold failure	On any absolute threshold failure a notification will be send to the application.