Skip to main content
Each check holds one result per page: same, new, changed, removed or error. A changed page comes with its diff. You can read it by polling, by webhook or by email. Reads are free, and a check is charged when it runs. See Pricing.

Checks

GET /v1/monitor/{id}/checks lists the checks of one monitor, newest first.
Filter with status, limit up to 100 (default 20) and offset. GET /v1/monitor/{id}/checks/{checkId} returns one check with data.pages, up to 100 per answer. Send limit and skip, follow next until null, or send status to keep one page status.

Search results

For a search target each page is a result, and metadata.searchStatus says what happened to it.

Changes

GET /v1/monitor/{id}/changes lists one row per page per check, newest first. Query: status (a changeStatus), url, limit up to 100 (default 20), cursor from next. Rows hold at, url, changeStatus (new, same, changed, removed, or null with an error when unreadable), diff, json and costUsd. Across monitors, GET /v1/monitor/checks (filters monitorId, status, trigger, limit, cursor, rows in data.checks) and GET /v1/monitor/changes (filters monitorId, status, url, limit, cursor, rows in data.changes with id, monitorId, monitorName) list everything. The change list leaves out the diff. GET /v1/monitor/changes/{id} reads one row with its diff.

Webhooks

Add webhook on create, or set it later with PATCH. PATCH replaces it as a whole, and "webhook": null removes it. The fields, delivery format, signature check, retries and delivery history are on Webhooks. Choose webhook.events: With targets and schedule and no events, you get monitor.page and monitor.check.completed. A monitor made with the older url, urls and interval fields gets monitor.changed and monitor.failed. The first check of page targets sends no monitor.page, but it does send monitor.check.completed. changeStatus is changed, new or removed. A removed page has only url, changeStatus and at. A search result also has title. With json comparison the event holds json. A judgment with meaningful: false is still sent. actualCredits on monitor.check.completed is an older field for costUsd.

Rotate the secret

Until you rotate, a monitor’s calls are signed with your account secret from POST /v1/webhook/secret. POST /v1/monitor/{id}/webhook/rotate-secret gives this monitor its own.
Store data.secret with its whsec_ prefix. The old secret stops signing this monitor’s calls at once, and your other jobs keep the account secret. A monitor with no webhook returns 400 invalidRequest.

Email

Set notification.email on create or update to get changes without a receiver. notification.email.recipientStates shows confirmed, pending or unsubscribed for each recipient.

Limits and errors

Codes are on Errors.
  • 404 notFound: a monitor, check or change id that does not exist, is not yours or has expired.
  • 400 invalidRequest: a cursor that is not the one from the last answer, webhook.url not public, or webhook.events.0: Send one of: monitor.page, monitor.check.completed, monitor.changed, monitor.failed.