MarkUDown

Monitor API — MarkUDown page change webhook API docs

POST/api/monitor

Monitor

Create a persistent URL monitor that checks a page on a schedule and POSTs a webhook notification whenever the content changes. Each subscription runs independently in the background until cancelled.

ParameterTypeRequiredDefaultDescription
urlstringrequired—URL to monitor.
callback_urlstringrequired—Webhook URL to POST a change notification to.
interval_minutesintegeroptional60How often to check the page, in minutes.
main_contentbooleanoptionaltrueCompare only the main content (ignores navigation and footer changes).
timeoutintegeroptional60Page load timeout in seconds.

Request

{
  "url": "https://books.toscrape.com/",
  "callback_url": "https://your-server.com/webhook",
  "interval_minutes": 30,
  "main_content": true
}

Response

// POST /api/monitor — creates subscription
{
  "success": true,
  "subscription_id": "a1b2c3d4-...",
  "url": "https://books.toscrape.com/",
  "interval_minutes": 30,
  "callback_url": "https://your-server.com/webhook"
}

// Webhook payload on change:
{
  "event": "change_detected",
  "subscription_id": "a1b2c3d4-...",
  "url": "https://books.toscrape.com/",
  "changed": true,
  "current_hash": "def456...",
  "previous_hash": "abc123...",
  "checked_at": "2026-04-22T14:30:00Z"
}

// GET /api/monitor — list active subscriptions
// DELETE /api/monitor/{subscription_id} — cancel