Request
This endpoint expects an object.
querystringRequired>=1 character
What to track.
webhookstring or nullOptional
Optional URL to POST events to. When set, the URL is verified to return 2xx before the monitor is created.
cadencestring or nullOptional
hourly | daily | weekly. Mutually exclusive with cron. Defaults to ‘daily’ if neither is set.
cronstring or nullOptional
Standard 5-field cron expression (e.g. ’*/15 * * * *’). Mutually exclusive with cadence.
modestringOptionalDefaults to diff
‘diff’ (only emit on content change) or ‘snapshot’ (always emit).
filter_promptstring or nullOptional
Natural-language predicate. After each run, Claude judges whether results satisfy it; only matches trigger the webhook when notify_on includes ‘match’.
webhook_secretstring or nullOptional
Write-only. When set, outgoing webhooks include an X-Scout-Signature: sha256=<hex> header (HMAC over the raw body) - same pattern as Stripe/GitHub webhooks.
webhook_retryobject or nullOptional
Retry policy on non-2xx webhook responses. Default: 3 attempts, 30s exponential backoff.
notify_onlist of strings or nullOptional
Which event types fire the webhook. Composable subset of: ‘change’ (content changed / snapshot), ‘match’ (filter_prompt returned true), ‘error’ (run errored). Default: [‘change’].
countrystringOptionalDefaults to us
languagestringOptionalDefaults to en
UI language code.
metadatamap from strings to any or nullOptional
Arbitrary caller metadata.
Response
Successful Response
idstring
Monitor identifier.
querystring
The tracked query.
cadencestring
hourly, daily or weekly.
statusstring
active or paused.
metadatamap from strings to any
Arbitrary caller metadata.
createdAtstring
ISO-8601 creation timestamp.
runsinteger
How many times the monitor has run.
cronstring or null
Cron expression (overrides cadence when present).
modestringDefaults to diff
'diff' or 'snapshot'.
filter_promptstring or null
Natural-language predicate evaluated by Claude.
notify_onlist of strings
Subset of: change | match | error.
webhook_max_attemptsintegerDefaults to 3
webhook_backoff_secondsintegerDefaults to 30
webhook_secret_setbooleanDefaults to false
True if a webhook_secret is configured (the secret itself is never returned).
webhookstring or null
Where change events are delivered, if set.
lastRunAtstring or null
ISO-8601 timestamp of the most recent run.
nextRunAtstring or null
ISO-8601 timestamp of the next run, or null when paused.
last_webhook_statusinteger or null
HTTP status of the most recent webhook delivery, or null.
last_webhook_atdouble or null
Epoch seconds the last webhook delivery completed.
last_webhook_errorstring or null
Error message from the last webhook delivery, when it failed; null on success or when no webhook is set.
last_resultobject or null
Summary of the most recent monitor event, or null.
