Skip to main content
POST
/
monitor
curl --request POST \
  --url https://api.firecrawl.dev/v2/monitor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Blog monitor",
  "schedule": {
    "text": "every 30 minutes",
    "timezone": "UTC"
  },
  "goal": "Notify me when a new blog post is published or the headline changes",
  "notification": {
    "email": {
      "enabled": true,
      "recipients": [
        "alerts@example.com"
      ],
      "includeDiffs": true
    }
  },
  "targets": [
    {
      "type": "scrape",
      "urls": [
        "https://example.com/blog"
      ]
    }
  ]
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "schedule": {
      "cron": "<string>",
      "timezone": "<string>"
    },
    "nextRunAt": "2023-11-07T05:31:56Z",
    "lastRunAt": "2023-11-07T05:31:56Z",
    "currentCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "urls": [
          "<string>"
        ],
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scrapeOptions": {
          "formats": [
            "markdown"
          ],
          "onlyMainContent": true,
          "onlyCleanContent": false,
          "includeTags": [
            "<string>"
          ],
          "excludeTags": [
            "<string>"
          ],
          "maxAge": 172800000,
          "minAge": 123,
          "headers": {},
          "waitFor": 0,
          "mobile": false,
          "skipTlsVerification": true,
          "timeout": 60000,
          "parsers": [
            "pdf"
          ],
          "actions": [
            {
              "milliseconds": 2
            }
          ],
          "location": {
            "country": "US",
            "languages": [
              "en-US"
            ]
          },
          "removeBase64Images": true,
          "blockAds": true,
          "proxy": "auto",
          "storeInCache": true,
          "lockdown": false,
          "profile": {
            "name": "<string>",
            "saveChanges": true
          }
        }
      }
    ],
    "webhook": {
      "url": "<string>",
      "headers": {},
      "metadata": {},
      "events": []
    },
    "notification": {
      "email": {
        "enabled": false,
        "recipients": [
          "jsmith@example.com"
        ],
        "includeDiffs": false
      }
    },
    "retentionDays": 123,
    "estimatedCreditsPerMonth": 123,
    "lastCheckSummary": {
      "totalPages": 123,
      "same": 123,
      "changed": 123,
      "new": 123,
      "removed": 123,
      "error": 123
    },
    "goal": "<string>",
    "judgeEnabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
Maximum string length: 256
​
schedule
object
required

Schedule for monitor checks. Provide either cron or text.

​
targets
(Scrape target · object | Crawl target · object)[]
required
Required array length: 1 - 50 elements
​
webhook
object

Webhook destination for monitor page and check completion events.

​
notification
object
​
retentionDays
integer
default:30
Required range: 1 <= x <= 365
​
goal
string | null

Plain-language goal used to judge whether changed pages are meaningful. If provided and judgeEnabled is omitted, judging is enabled automatically.

Maximum string length: 2000
​
judgeEnabled
boolean

Whether to judge changed pages against goal. Requires a non-empty goal to run.

Response

Monitor created

​
success
boolean
​
data
object