Monitor API
Update a monitor
Replace a monitor’s name, goal, targets, schedule, webhook, or metadata.
PATCH
Each top-level field you send replaces that whole field; omitted fields stay unchanged. This is not a nested merge. An empty object returns the monitor unchanged.
Send
null to clear goal, metadata, or webhook: the goal becomes "", metadata becomes {}, and removing a webhook stops notifications without stopping runs. null is not accepted for name, targets, or schedule.
Replace targets or schedules
targets replaces the entire array, including each target’s configuration. Repeat required fields and any non-default settings you want to keep. For Search targets, omitting max_results restores its default of 20; omitted filters restore both freshness date types and unrestricted domains.
You can switch between exactly one Search target and 1 to 10 Page targets, but cannot mix them or send an empty array. Updating targets preserves existing run windows, seen-URL history, and stored Page baselines, subject to retention. A Page URL with no stored baseline establishes one on its first successful fetch.
A new schedule replaces the whole schedule and recomputes next_run_at. Include its type and the required fields for that schedule.
Add, replace, or remove a webhook
Awebhook object replaces the whole webhook, so include its url and any event subscriptions you want to keep. Omitting events or sending an empty array selects the defaults: monitor.changes.detected and monitor.paused.
Omitting secret keeps the existing secret. When you add a webhook to a monitor that has none, omitting secret generates one and returns it in this response’s webhook.secret; store it to verify deliveries.
Providing a different secret rotates it. Deliveries are signed with both the new and old secret for 24 hours, and a secret you supply is never returned. After configuring the webhook, use Test a monitor’s webhook to check delivery.
Authorizations
Body
application/json
Any subset of the writable fields. A present key replaces that whole
field; an absent key leaves it unchanged. null clears an optional
field: goal becomes "", metadata becomes {}, webhook is
removed.
Response
The updated monitor
Fields that do not apply are omitted, never null: webhook,
pause_reason, current_run_id, next_run_at and last_run.