Skip to main content
Documentation

Set up CrawlPanel in six steps.

Create your first project and monitors, connect alerts and learn how to investigate incidents and confirm recovery.

Quick start

A clear path to your first monitored journey.

The product is organized around organizations, projects, monitors, runs and incidents.

Project

One monitored website or application, including its monitors, incidents, client access and reports.

Run & evidence

One execution with status and timing, plus an incident snapshot or journey evidence where available.

Incident

A confirmed period of failure with a timeline, protected evidence, acknowledgement and automatic recovery. GET website incidents capture a page view or visual diagnostic in the background after the alert is sent.

Alert destinations

Connect, test, activate, then route.

Every destination follows the same safe workflow. CrawlPanel stores external credentials encrypted and requires a successful production-path test before activation.

Email

Add recipients for an additional person or shared inbox. The workspace owner safety route remains active.

Slack

Paste an official incoming webhook URL created for the destination channel.

Microsoft Teams

Create a Teams Workflows flow that receives a webhook request and paste its callback URL.

Discord

Create a webhook in the destination channel’s Integrations settings and paste its URL.

Telegram

Create a BotFather bot, add it to the chat, then enter its token and chat ID or public @channel username.

PagerDuty

Add an Events API v2 integration to a PagerDuty service and paste its integration key.

Signed webhook

Use any HTTPS JSON endpoint and optionally add an HMAC-SHA256 signing secret.

Webhook contract

A signed, retry-safe event envelope.

Generic webhook destinations receive HTTPS POST requests. Return any 2xx response to acknowledge delivery and deduplicate by the delivery ID.

Request

POST https://your-service.example/hooks/crawlpanel
content-type: application/json
x-crawlpanel-event: incident.opened
x-crawlpanel-delivery: <unique-delivery-id>
x-crawlpanel-timestamp: <unix-seconds>
x-crawlpanel-signature: t=<timestamp>,v1=<hex-hmac>

The signature header is present when a signing secret is configured. CrawlPanel uses HMAC-SHA256 over timestamp + "." + rawBody.

Envelope and delivery

{
  "id": "<unique-delivery-id>",
  "type": "incident.opened",
  "createdAt": "2026-07-29T11:42:00.000Z",
  "data": { "...": "event-specific fields" }
}
  • Verify the signature against the unmodified request body.
  • Reject stale timestamps according to your own replay window.
  • Use the delivery ID as the idempotency key.
  • Non-2xx responses and delivery errors retry up to five attempts with exponential backoff.

Ready to create your first monitor?

Try every Business feature free for 14 days. No credit card required.