docimprint
Try live

← All docs

On this pageMonitor

Monitor

DocImprint ·

What does DocImprint URL monitor do?

POST /v1/monitor schedules periodic checks against a document URL. When content changes, DocImprint creates a new bundle and sends a webhook with a signed diff highlighting changed sections ($0.50/monitor).

How do monitor webhooks work?

Register a webhook URL when creating a monitor. On change detection, DocImprint POSTs a JSON payload with monitor_id, previous bundle_id, new bundle_id, and changed section summaries signed with your webhook secret.

When should agents use URL monitor?

Use monitor for regulatory filings, policy pages, contract terms online, and any URL where change detection triggers agent action — compliance alerts, contract renegotiation, or insurance policy updates.

Monitor

$0.50

Register a URL monitor with webhook callbacks when content changes. Useful for compliance tracking, terms-of-service diffs, and agent workflows that need to react to document updates.

  • POST/v1/monitor$0.50

    Watch a URL on a schedule and POST change events to your webhook_url. Mode controls diff vs re-extract behavior.

  • GET/v1/monitorFree

    List monitors for the authenticated owner, including remaining checks and last-run status.

  • GET/v1/monitor/{id}Free

    Single monitor config: URL, webhook, mode, and current status.

  • GET/v1/monitor/{id}/historyFree

    Chronological change detections / runs for one monitor — what changed and when.

  • DELETE/v1/monitor/{id}Free

    Stop watching the URL and remove the monitor registration.

bashCreate monitor
curl -X POST https://api.docimprint.com/v1/monitor \
  -H "Content-Type: application/json" \
  -H "X-Payment: <token>" \
  -d '{
    "url": "https://example.com/terms",
    "webhook_url": "https://myapp.com/webhooks/docimprint",
    "mode": "diff"
  }'
jsonResponse
{
  "id": "mon_xyz789",
  "url": "https://example.com/terms",
  "checks_remaining": 1439,
  "created_at": "2025-05-23T12:00:00Z"
}

Compare mode on extract diffs against a previous bundle — see Extract guide → Compare

Related

All docs

Hub

Try live

Playground

Extract guide

Modes