Skip to content
/
run audit now

run audit now

Request

POST /v3/web-audits/{auditId}/runs
Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
Bodyapplication/jsonrequired

Run the audit now. The request must contain the web-audit ID. Unlike v2 "run now" API, this API does not reject run requests if there is an active run.

startingUrlsArray of strings or null, >= 0 items
callbackWorkflowEventTypestringrequired

The workflow file to be used in for starting the callback workflow Has to be a file name without extension, e.g. "audit-complete" instead of "audit-complete.yml"

callbackRepositoryOwnerstringrequired

The owner of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow

callbackRepositoryNamestringrequired

The name of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow

callbackContextobject

Contains a context for the callback URL to be used in the run

maxPagesinteger or null

Maximum number of pages to scan during the audit run. If not provided, will default to the count of starting URLs if it exceeds the current audit configuration limit.

ghAppNamestring

GitHub App to use for the callback workflow dispatch. Defaults to observepoint-integration if not specified (handled in service layer).

Enum:"observepoint-integration""observepoint-test-app"
POST
/v3/web-audits/{auditId}/runs
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "startingUrls": [
      "string"
    ],
    "callbackWorkflowEventType": "string",
    "callbackRepositoryOwner": "string",
    "callbackRepositoryName": "string",
    "callbackContext": {},
    "maxPages": 0,
    "ghAppName": "observepoint-integration"
  }'

Responses

Run started successfully

Response
No content