---
title: "Create Monitor"
method: POST
path: "/v1/site-monitors"
tags: ["SiteMonitors"]
---

# Create Monitor

`POST /v1/site-monitors`

## Request

- Base URL: `https://api.scrapegraphai.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.scrapegraphai.com/v1/site-monitors`
- Auth: none declared

Register a website for monitoring. We will check on the given cron schedule and POST webhook events on content change.

## Request body

- SiteMonitorCreate: Request body for registering a new site monitor.
  - `name` string, nullable: Human-readable name for the monitor
  - `website_url` string, required: URL to monitor
  - `webhook_url` string, required: URL to POST webhook events to
  - `cron_expression` string, required: Cron schedule (5 fields, UTC), e.g. '*/15 * * * *' for every 15 min
  - `extraction_config` SiteMonitorExtractionConfig: Optional extraction config for monitored page (smartscraper-style).
    - `user_prompt` string, nullable: Prompt for extracting structured data from the page
    - `output_schema` object, nullable: JSON schema for extracted fields (enables structured diff)

## Response `200`

Successful Response

- SiteMonitorResponse: Response for a single site monitor.
  - `id` string, uuid, required
  - `user_id` string, uuid, required
  - `api_key_id` string, uuid, required
  - `name` string, nullable
  - `website_url` string, required
  - `webhook_url` string, required
  - `cron_expression` string, required
  - `extraction_config` object, nullable
  - `is_active` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `last_run_at` string, date-time, nullable
  - `next_run_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api.md) - [All operations](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api/revisions/a0e42195429f?raw)