SDK ReferenceTypeScript SDK

Monitors

Watch a URL on a schedule and webhook on change.

Monitors

Watch a URL on a schedule and webhook on change. Accessed via client.monitors.

create

client.monitors.create(opts: Record<string, unknown>): Promise<unknown>

POST /v1/monitors — create a visual-change monitor

list

client.monitors.list(): Promise<unknown>

GET /v1/monitors — list all monitors for the account

get

client.monitors.get(id: MonitorId): Promise<unknown>

GET /v1/monitors/{id} — get a monitor by ID

update

client.monitors.update(id: MonitorId, opts: Record<string, unknown>): Promise<unknown>

PATCH /v1/monitors/{id} — update a monitor

delete

client.monitors.delete(id: MonitorId): Promise<unknown>

DELETE /v1/monitors/{id} — delete a monitor

captures

list

client.monitors.captures.list(id: MonitorId): Promise<unknown>

GET /v1/monitors/{id}/captures — list captures for a monitor