> ## Documentation Index
> Fetch the complete documentation index at: https://outcrawl.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Watch a URL on a schedule, notify on real change.

export const OutcrawlStyles = () => {
  if (typeof document !== 'undefined' && !document.getElementById('outcrawl-overrides')) {
    const s = document.createElement('style');
    s.id = 'outcrawl-overrides';
    s.textContent = `
      /* Match the product's radius grid (4 / 6 / 8 / 9999), not Mintlify's default. */
      .rounded-sm { border-radius: 0.375rem !important; } /* 6px, --r-ctl */
      .rounded-md { border-radius: 0.375rem !important; } /* 6px, --r-ctl */
      .rounded-lg { border-radius: 0.5rem !important; }   /* 8px, --r-panel */
      .rounded-l-sm { border-top-left-radius: 0.375rem !important; border-bottom-left-radius: 0.375rem !important; }
      .rounded-r-sm { border-top-right-radius: 0.375rem !important; border-bottom-right-radius: 0.375rem !important; }
      .rounded-l-md { border-top-left-radius: 0.375rem !important; border-bottom-left-radius: 0.375rem !important; }
      .rounded-r-md { border-top-right-radius: 0.375rem !important; border-bottom-right-radius: 0.375rem !important; }
      .rounded-l-lg { border-top-left-radius: 0.5rem !important; border-bottom-left-radius: 0.5rem !important; }
      .rounded-r-lg { border-top-right-radius: 0.5rem !important; border-bottom-right-radius: 0.5rem !important; }

      /* Cards: never pure white in light mode, matching the one-big-card surface tone. */
      .card { background-color: #fcfcfc !important; border-radius: 0.5rem !important; }
      html.dark .card { background-color: #141311 !important; }

      /* Docs hero box */
      .oc-hero { background-color: #fcfcfc; border: 1px solid #e5e2dc; }
      html.dark .oc-hero { background-color: #141311; border-color: #26241f; }
      html.dark .oc-hero h1 { color: #edeae4; }

      /* Thin, transparent-track, hide-until-hover scrollbar. */
      ::-webkit-scrollbar { width: 6px; height: 6px; background-color: transparent; }
      ::-webkit-scrollbar-track { background-color: transparent; }
      ::-webkit-scrollbar-thumb { background-color: rgba(155, 155, 155, 0.5); border-radius: 10px; transition: opacity 0.3s ease; opacity: 0; }
      ::-webkit-scrollbar-thumb:hover { background-color: rgba(155, 155, 155, 0.7); }
      *:hover::-webkit-scrollbar-thumb,
      *:focus::-webkit-scrollbar-thumb,
      *:active::-webkit-scrollbar-thumb { opacity: 1; }
      * { scrollbar-width: thin; scrollbar-color: rgba(155, 155, 155, 0.5) transparent; }
    `;
    document.head.appendChild(s);
  }
  return null;
};

<OutcrawlStyles />

A monitor watches a URL on a schedule and notifies you when it genuinely changes. Use it for recurring checks, a pricing page, a status page, a listing; not for a one-off comparison, that is just two scrapes.

The rate is **1 credit per check**, whether or not the page changed, so the schedule sets the floor: an hourly monitor is about 720 credits a month. A monitor created with `judge: true` runs a model over each change it finds, and also bills that model's usage in credits. See [pricing](/docs/billing/pricing).

## Notify targets

Three, and only for a monitor: Discord, Slack, or a bare webhook URL.

<Warning>
  Monitor notifications are sent once. They are **not retried**. If your endpoint is down when a change fires, that notification is gone. `monitors.list` shows only when each monitor last checked and what it found (`lastCheckedAt`, `lastStatus`), not the diff, and there is no call that reads past checks, so keep your endpoint up. This is different from an agent run's webhook, which does retry, see [agent monitoring](/docs/agents/monitoring) for the contrast.
</Warning>

<CodeGroup>
  ```typescript TypeScript theme={"theme":{"light":"github-light","dark":"catppuccin-mocha"}}
  import { Outcrawl } from '@outcrawl/sdk';

  const oc = new Outcrawl();
  const monitor = await oc.monitors.create({
    url: 'https://example.com/pricing',
    schedule: '0 * * * *',
    notify: { webhook: 'https://yourapp.example/hooks/outcrawl' },
  });
  const monitors = await oc.monitors.list();
  console.log(monitor.id, monitors.length);
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"catppuccin-mocha"}}
  import asyncio
  from outcrawl import Outcrawl

  async def main():
      async with Outcrawl() as oc:
          monitor = await oc.monitors.create(
              url="https://example.com/pricing",
              schedule="0 * * * *",
              notify={"webhook": "https://yourapp.example/hooks/outcrawl"},
          )
          monitors = await oc.monitors.list()
          print(monitor["id"], len(monitors))

  asyncio.run(main())
  ```

  ```bash curl theme={"theme":{"light":"github-light","dark":"catppuccin-mocha"}}
  curl https://api.outcrawl.ai/v1/monitors \
    -H "Authorization: Bearer ock_YOUR_KEY_ID.YOUR_SECRET" \
    -H "Content-Type: application/json" \
    -d '{
      "url": "https://example.com/pricing",
      "schedule": "0 * * * *",
      "notify": { "webhook": "https://yourapp.example/hooks/outcrawl" }
    }'

  curl https://api.outcrawl.ai/v1/monitors -H "Authorization: Bearer ock_YOUR_KEY_ID.YOUR_SECRET"
  ```
</CodeGroup>

<Card title="Agents" icon="player-play" href="/docs/agents/overview">
  Agent-run webhooks are a different mechanism, and unlike a monitor's, they do retry: up to 8 attempts over about 3 hours 40 minutes.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.