Skip to main content
WEBHOOK
SCAN_SCHEDULED
{
  "time": 1,
  "host": "<string>",
  "source": "<string>",
  "sourcetype": "SCAN_STARTED",
  "event": {
    "timestamp": "2023-11-07T05:31:56Z",
    "organization": {
      "id": "<string>",
      "name": "<string>"
    },
    "repository": {
      "id": "<string>",
      "name": "<string>"
    },
    "scan": {
      "id": "<string>",
      "type": "<string>",
      "status": "started",
      "duration_minutes": 1,
      "vulnerability_summary": {
        "total": 1,
        "by_severity": {
          "critical": 1,
          "high": 1,
          "medium": 1,
          "low": 1,
          "info": 1
        }
      },
      "url": "<string>"
    },
    "audit_log": {
      "id": "<string>",
      "endpoint": "<string>",
      "arguments": "<any>",
      "caller": {
        "id": "<string>",
        "email": "<string>"
      },
      "timestamp": "2023-11-07T05:31:56Z"
    },
    "error": "<string>",
    "metadata": {
      "scheduleId": "<string>",
      "crontab": "<string>",
      "isEnabled": true,
      "action": "created"
    },
    "vulnerability": {
      "id": "<string>",
      "url": "<string>"
    }
  }
}

Body

application/json
​
time
integer
required

Unix epoch seconds

Required range: x >= 0
​
host
string
required
​
source
string
required
​
sourcetype
enum<string>
required

Type of event being delivered. Matches internal NotificationEventType.

Available options:
TitleConst
SCAN_SCHEDULED
​
event
object
required

Response

200

OK