Guides

Schedules & workflows

Re-crawl on an interval, watch for site changes, and run automations when a job completes.

Schedules

A schedule re-crawls a fixed URL set on an interval. kind: "monitor" watches for content changes between crawls.

bash

curl -X POST https://api.orbicrawl.com/api/v1/schedules \
  -H "X-API-Key: oc_live_..." -H "Content-Type: application/json" \
  -d '{
    "name": "Competitor watch",
    "kind": "monitor",
    "urls": ["https://competitor.com"],
    "interval_minutes": 1440,
    "incremental": true
  }'

interval_minutes — minimum 5; the dispatcher fires due schedules every minute.
POST /schedules/{id}/run — run immediately.
GET /schedules/changes — the change feed (sites whose content changed).

Workflows

A workflow runs a sequence of steps against a job's leads — on demand, or automatically when a job completes. Today's step type pushes leads to a connected integration.

bash

curl -X POST https://api.orbicrawl.com/api/v1/workflows \
  -H "X-API-Key: oc_live_..." -H "Content-Type: application/json" \
  -d '{
    "name": "Sync to CRM",
    "trigger": "job_completed",
    "steps": [{ "action": "push_integration", "integration_id": "INTEGRATION_ID" }]
  }'

Run one against a specific job:

bash

curl -X POST https://api.orbicrawl.com/api/v1/workflows/WORKFLOW_ID/run \
  -H "X-API-Key: oc_live_..." -H "Content-Type: application/json" \
  -d '{ "job_id": "JOB_ID" }'

Note

With trigger: "job_completed", the workflow fires automatically the first time each job finishes — no polling required.