Skip to main content
POST
Create a monitor

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Any unique string up to 255 visible characters. Send the same key when you retry a request: for 12 hours a repeat returns the first answer again, with an Idempotent-Replayed: true header, without doing the work or charging a second time. A repeat that arrives while the first is still running gets 409 IDEMPOTENCY_IN_PROGRESS; the same key with a different body gets 409 IDEMPOTENCY_KEY_REUSED.

Maximum string length: 255
Example:

"3f2b8c1e-retry-safe-key"

Body

application/json
name
string
required
Maximum string length: 200
Example:

"Competitor pricing"

schedule
object
required
targets
object[]
required

What to watch, up to 10 targets: pages, a whole site, or a search.

webhook
object
retentionDays
integer
default:30

How many days of check history to keep.

Required range: 1 <= x <= 365
email
enum<string>
default:off

Send the workspace owner a daily email listing what this monitor found. Nothing is sent on a day without changes.

Available options:
off,
daily

Response

data
object
required