Create a storm monitor: email and/or webhook alerts when a qualifying storm enters an area

Provide an area (GeoJSON geometry or bbox) plus at least one alert channel: webhook_url and/or email_alerts: true (emails go only to the account owner's address). hail_min_in defaults to 1.00. With webhook_url, the response includes webhook_secret exactly once. Costs 1 credit.

post/v1/monitors

Request

  • Base URL: https://swathapi.com
  • URL: https://swathapi.com/v1/monitors
  • Auth: HTTP bearer

Request body

namestring

Human label for the monitor

geometryobject

GeoJSON Polygon or MultiPolygon in WGS84 (alternative to bbox)

bboxnumber[]

[west, south, east, north] in WGS84 degrees (alternative to geometry)

hail_min_innumber

Minimum hail size in inches to trigger (default 1.00)

wind_min_mphnumber

Minimum wind speed in mph to trigger

webhook_urlstring

http(s) URL that receives signed alert POSTs (optional if email_alerts is true)

email_alertsboolean

Email storm alerts to the account owner's address — no other recipient is possible (default false)

Response

Monitor created (webhook_secret shown only in this response)

idstring

Monitor id (mon_...)

namestring nullable
hail_min_innumber nullable

Trigger threshold, inches

wind_min_mphnumber nullable

Trigger threshold, mph

webhook_urlstring nullable
email_alertsboolean

Email the account owner on each verified storm

created_atstring date-time
geometryobject

GeoJSON MultiPolygon of the monitored area

webhook_secretstring

HMAC secret (whsec_...) for verifying webhook payloads — returned only at creation

Changes

No recorded changes to this operation across all 1 revision of this API.