FeaturePOST /v1/jobs

Website Monitoring

Scheduled checks with jobs and signed webhooks. Assert, screenshot, or facts — automatic and pipeline-ready.

What you can do with monitoring jobs

Batch or scheduled checks as a job: Scout runs requests and delivers results via poll or signed webhook. Jobs orchestrate the same primitives — screenshot, inspect, assert, and more.

Multiple requests in one job (screenshot, inspect, assert, …)
Optional signed webhooks to your system
Poll results via GET /v1/jobs/:id
Foundation for alerts, tickets, and auto-remediation

API Call

editable

Request body

{'{'}

{'}'}

Smoke check like monitoring jobs: change selector and visible, then run.

Response

Not run yet

Assert: h1 visible=true on example.com

Endpoints & parameters

Choose an endpoint — below you'll see an example request and explanations for all relevant parameters.

POST /v1/jobs

Enqueue batch job; credits = sum of nested requests.

Example request

json

{
  "webhook_url": "https://hooks.example.com/scout",
  "webhook_secret": "whsec_example",
  "requests": [
    {
      "type": "assert",
      "body": {
        "url": "https://example.com",
        "assert": [
          {
            "selector": "h1",
            "visible": true
          }
        ]
      }
    },
    {
      "type": "screenshot",
      "body": {
        "url": "https://example.com",
        "format": "jpeg",
        "mode": "viewport"
      }
    }
  ]
}

Parameters

requestsarray required
List of { type, body } — type maps to Scout primitives (assert, screenshot, inspect, …).
webhook_urlstring
Callback URL for job result.
webhook_secretstring
HMAC secret; otherwise key/env default.