Snag Watcher

API reference

The watcher object

FieldType
watcher_idstringwch_ plus 20 characters
kindstringprice, availability, release or mixed, worked out from the conditions
statusstringSee below
parent_idstring or nullSet on a follow-up
requestobjectThe body you sent, as last updated
schedule.everystringThe interval it runs at, after any clamp
schedule.next_run_atstring or nullnull once it stops
schedule.untilstring or nullWhen it expires. null for after_first_match and never
clampedarrayChanges we made to the schedule, and why
warningsstring[]Things to check, like a site read without built-in support
created_at, last_run_at, first_match_atstring or nullISO 8601, UTC
metadataobjectYour labels from metadata, or {} if you set none
last_snapshotobject or nullThe last run: run_at, matched, and for each site outcome, candidates, fields and issues
eventsarrayThe last 20 events. Left out of lists
webhook_secretstringOnly in the create response, or when an update adds a webhook

Status

statusMeansNext
activeRunning on schedulepaused, matched, expired
pausedNot running because you paused itactive, expired
matchedStopped at its first matchFinal
expireduntil passedFinal