Integrations

Connect your pipeline. Carry the evidence.

API keys, scan triggers, deployment webhooks, and outbound webhooks. Connect Crawlens to your delivery pipeline without overclaiming native adapters.

WebhooksAPI KeysDeploy Webhooks
API

Integration Surfaces Built for Operations

Copy, paste, and trigger visual checks from your existing CI/CD pipeline in under 5 minutes.

01

Webhooks

Receive real-time notifications when scans complete. Payloads include change detection results, visual diffs, and snapshot metadata.

02

API Keys

Generate scoped API keys with granular permissions. Trigger scans, retrieve snapshots, and manage projects via our RESTful API.

03

Deploy Webhooks

Connect Vercel or Netlify deploy hooks to automatically trigger visual scans after every deployment, with deployment markers on your charts.

webhook-payload.json
{
  "event": "crawl.success",
  "timestamp": "2026-01-15T10:30:00Z",
  "url_id": "67d0f9ab12cd34ef56a7b890",
  "url": "https://example.com/checkout",
  "snapshot_id": "67d0f9ab12cd34ef56a7b891"
}
scan-trigger.sh
curl -X POST "$API_BASE/api/projects/$PROJECT_ID/scan" \
  -H "Authorization: Bearer $CRAWLENS_API_KEY" \
  -H "X-Org-ID: $ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"triggered_by":"ci"}'
PLAN-AWARE INTEGRATION ACCESS

Integrations are org-scoped. Limits and advanced controls are applied by plan so teams can scale safely without overclaiming capability.

FREE

Webhooks and alert rules are off on Free; the API documentation and setup references are open.

PRO

Up to 2 webhooks and 10 alert rules, including CI/CD-triggered scans and notification routing.

AGENCY

Webhook and alert capacity for a site portfolio (25 webhooks / high-capacity alert rules), with longer evidence history and more seats.

Webhooks

Real API Examples

This section maps directly to active backend routes and delivery behavior in production code.

deployment-webhook.sh
curl -X POST "$API_BASE/api/projects/$PROJECT_ID/deployments" \
  -H "Content-Type: application/json" \
  -H "X-Webhook-Secret: $WEBHOOK_SECRET" \
  -d '{
    "version":"v1.4.2",
    "author":"release-bot",
    "commit_msg":"checkout css fixes",
    "commit_sha":"1a2b3c4d",
    "environment":"production"
  }'
webhook-register.sh
curl -X POST "$API_BASE/api/webhooks" \
  -H "Authorization: Bearer $CRAWLENS_API_KEY" \
  -H "X-Org-ID: $ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "provider":"custom",
    "url":"https://hooks.example.com/crawlens",
    "events":["crawl.success","crawl.failed"],
    "secret":"whsec_prod_123",
    "headers":{"X-Env":"production"}
  }'
inbound-webhook-trigger.sh
curl -X POST "$API_BASE/api/webhook/trigger" \
  -H "Content-Type: application/json" \
  -H "X-Hub-Signature-256: sha256=<hmac_signature>" \
  -d '{"project_id":"$PROJECT_ID"}'
Supported outbound webhook events
  • crawl.success — sent after successful crawl completion
  • crawl.failed — sent when crawl execution fails
  • alert.rule_triggered — sent when an alert rule is triggered
Delivery headers
X-Webhook-Event: <event_name>
X-Webhook-Delivery: <delivery_id>
X-Webhook-Idempotency-Key: <event:id>
X-Webhook-Signature: sha256=<hmac>   # only when secret is set
Security and delivery guarantees
  • Signed delivery: X-Webhook-Signature (HMAC SHA-256) when secret is configured.
  • Inbound protection: X-Hub-Signature-256 verification for trigger endpoint and optional X-Webhook-Secret for deploy endpoint.
  • Async retries with backoff, redrive endpoint support, and delivery logs for incident triage.
Endpoints

Verified webhook architecture

Delivery behavior is designed for operational reliability and traceability.

01

Outbound webhooks (org-scoped)

Create/manage outbound subscriptions and inspect delivery history. Plan-gated by organization.

POST /api/webhooks
GET /api/webhooks
PATCH /api/webhooks/{id}
DELETE /api/webhooks/{id}
GET /api/webhooks/{id}/deliveries
GET /api/webhooks/stats
POST /api/webhooks/{id}/deliveries/{delivery_id}/redrive
02

Inbound scan trigger

Accept signed incoming webhook calls and start scans from external systems.

POST /api/webhook/trigger
GET /api/webhook/status/{task_id}
03

Deployment marker webhook

Record deploy events to correlate release windows with visual/performance changes.

POST /api/projects/{project_id}/deployments
04

Operational proof panel

Concrete outputs from webhook stats and redrive flows that ops teams can use during incidents.

Delivery statistics · webhook-stats-response.json
{
  "window_hours": 24,
  "totals": {
    "pending": 2,
    "success": 183,
    "failed": 7,
    "completed": 190
  },
  "success_rate": 0.9632,
  "p95_delivery_latency_ms": 842.5,
  "avg_attempts": 1.18,
  "retry_ratio": 0.091
}
Redrive · webhook-redrive.sh
curl -X POST "$API_BASE/api/webhooks/$WEBHOOK_ID/deliveries/$DELIVERY_ID/redrive" \
  -H "Authorization: Bearer $CRAWLENS_API_KEY" \
  -H "X-Org-ID: $ORG_ID"
Catalog

Integration Coverage

Current product coverage per tool. GA = directly supported today, Soon = roadmap.

GA

GitHub Actions

Trigger scans from your CI/CD pipeline.

GA

GitLab CI

Trigger scheduled scans from GitLab pipelines via API/webhook.

GA

Jenkins

Post-build visual checks via scan trigger API.

GA

CircleCI

Run visual tests in CircleCI via API/webhook.

GA

Slack

Alert delivery via Slack webhook channel.

GA

Vercel

Auto-scan on deploy webhook.

GA

Netlify

Deploy hooks trigger visual scans.

Soon

Discord

Provider-specific Discord adapter is planned.

Soon

PagerDuty

Dedicated PagerDuty connector is planned.

GA — GA integrations are directly supported today via API/scan/deployment endpoints.Soon — Soon integrations are listed for roadmap visibility and will be upgraded from generic webhook/API usage.

Carry the evidence.

API keys, scan triggers, deployment webhooks, and outbound webhooks. Connect Crawlens to your delivery pipeline without overclaiming native adapters.

Get support ↗