watchers

WATCHER: get a signed callback when the US National Weather...

WATCHER: get a signed callback when the US National Weather Service issues a new alert for an area. Arm once, pay once. Pass area (2-letter state/territory code, e.g. CA, TX); optionally severity to only fire at/above a level (Minor/Moderate/Severe/Extreme). Fires once per new alert (deduped by id); bounded by maxFires/expiry. Active alerts at arm time are baselined. Free public-domain (NWS). Signed + retried; recoverable via watchers.status. Returns a watcherId.

post/api/watchers/weather-alert

Request

  • Base URL: https://2s.io
  • URL: https://2s.io/api/watchers/weather-alert
  • Auth: API key in header PAYMENT-SIGNATURE

Request body

areastring required

US state/territory code, e.g. CA, TX, FL.

severity'Minor' | 'Moderate' | 'Severe' | 'Extreme'

Optional: only fire on alerts of this severity.

callbackUrlstring uri required

Signed event POSTed here (verify X-2s-Signature). Any http(s) URL.

payloadobject

Arbitrary JSON echoed back in every callback.

expiresInSecondsinteger

Active window in seconds (default 30d, max 90d).

maxFiresinteger

Stop after this many alerts (default 25).

labelstring

Optional free-text tag.

Response

(unresolved $ref)

Changes

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