@kentcdodds/hydrawise

@kentcdodds/hydrawise

Intent

Server-side Hunter Hydrawise irrigation helpers for listing controllers, reading zone schedules, and running or suspending zones.

When To Use

• List controllers or read zone status without side effects (get-controllers, list-zones).
• Run, stop, or suspend one zone or all zones (mutating — requires explicit action params).
• Call the compact request helper for a raw Hydrawise REST endpoint under /api/v1/.

Required setup

• Secret hydrawiseApiKey — Hunter Hydrawise API key (Account Details → Generate API Key).
• Prefill: https://heykody.dev/account/secrets/new?name=hydrawiseApiKey&description=Hunter%20Hydrawise%20API%20key&allowedHosts=api.hydrawise.com&scope=user

Exports

• . — default dispatch router plus named helpers (getControllers, listZones, runZone, …) and request.

Example

import hydrawise, { request } from 'kody:@kentcdodds/hydrawise'

export default async function main() {
	const zones = await hydrawise({ action: 'list-zones' })
	const details = await request('customerdetails.php')
	return { zones, controllerCount: details?.controllers?.length }
}

Notes

• Hydrawise does not publish an OpenAPI spec (PDF REST guide only). This package uses one compact request helper that appends api_key={{secret:hydrawiseApiKey}} (resolved by Kody's fetch gateway) — query-param secrets are not an OpenAPI scaffold auth kind.
• Endpoints: customerdetails.php, statusschedule.php, setzone.php on https://api.hydrawise.com/api/v1/.
• Mutating actions (run-*, stop-*, suspend-*, resume-*) hit setzone.php — use only when explicitly requested.
• Morning briefing contract: pkg('hydrawise', '.', { action: 'list-zones' }) → { zones, nextPollSeconds } with zone fields number, nextRunInSeconds, nextRunTimeLabel, runDurationSeconds.