Skip to main content
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

A webhook 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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

monitor_id
string
required

Monitor identifier (mon_...)

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.

name
string
Required string length: 1 - 256
goal
string | null
Maximum string length: 2000
targets
object[]

Exactly one search target, or 1 to 10 page targets with distinct URLs

Required array length: 1 - 10 elements
schedule
object
webhook
object | null

Replaces the webhook. Without a secret, keeps the current one, or on a monitor without a webhook generates one and returns it in webhook.secret of this response. A new secret rotates. null removes the webhook; runs continue and nothing is sent.

metadata
object | null

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.

id
string
required

Opaque ID with the prefix mon_

Maximum string length: 64
object
enum<string>
required
Available options:
monitor
name
string
required
goal
string
required

"" when unset

targets
object[]
required

One thing a monitor watches. Today a monitor has exactly one search target, or 1 to 10 page targets with distinct URLs. New types may be added; skip targets with an unknown type.

schedule
object
required

When a monitor runs. New types may be added.

metadata
object
required

Up to 16 key value pairs; keys 1 to 64 characters, values up to 512 characters (Unicode code points, valid UTF-8). Echoed on every webhook.

status
enum<string>
required

active monitors run on their schedule; paused ones don't run until resumed. Whether a run is in flight is current_run_id, not the status. New statuses may be added; treat an unknown one as not running on its schedule.

Available options:
active,
paused
created_at
string<date-time>
required

RFC 3339 in UTC with whole seconds, for example 2026-11-12T09:00:41Z.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
updated_at
string<date-time>
required

RFC 3339 in UTC with whole seconds, for example 2026-11-12T09:00:41Z.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
webhook
object
pause_reason
enum<string>

Only while paused

Available options:
user,
insufficient_credits,
org_policy,
webhook_failing,
source_failing
current_run_id
string

The queued or running run

next_run_at
string<date-time>

Omitted while paused

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
last_run
object

The last finished run