Links

Event Types

The list of all event types HostedScan currently sends.

scan.succeeded

Occurs whenever a scan has successfully completed running. The event data is a Scan object.
{
"data": {
"id": "string",
"type": "NMAP || OPENVAS || OWASP_ZAP",
"state": "SUCCEEDED",
"progress": 100,
"results": [
{
"result_id": "string",
"content_type": "text/html"
}
],
"requested_targets": [
{
"target_id": "string",
"target": "string"
}
],
"resolved_targets": [
{
"target_id": "string",
"resolved_target": "string"
}
],
"skipped_targets": [
{
"target_id": "string",
"skipped_reason": "string"
}
]
}
}

risk.opened

Occurs whenever a new risk is found. The event data is a Risk objects.
{
"data": {
"id": "string",
"target_id": "string",
"target": "string",
"tags": [],
"status": "OPEN",
"risk_definition": {
"scan_type": "NMAP || OPENVAS || OWASP_ZAP",
"title": "string",
"threat_level": "LOW || MEDIUM || HIGH",
"description"?: "string", // optional - may not be available for all scanners
"solution"?: "string", // optional - may not be available for all scanners
"references"?: string[], // optional - may not be available for all scanners
"cvss"?: "string", // optional - may not be available for all scanners
"additional_info": { // scanner specific output - structure is different per scan type and could change when scanners are upgraded to new major versions
"key": "value"
}
}
}
}

risk.closed

Occurs when a risk is no longer found to be open. The event data is a Risk object.
{
"data": {
"id": "string",
"target_id": "string",
"target": "string",
"tags": [],
"status": "CLOSED",
"risk_definition": {
"scan_type": "NMAP || OPENVAS || OWASP_ZAP",
"title": "string",
"threat_level": "LOW || MEDIUM || HIGH",
"description"?: "string", // optional - may not be available for all scanners
"solution"?: "string", // optional - may not be available for all scanners
"references"?: string[], // optional - may not be available for all scanners
"cvss"?: "string", // optional - may not be available for all scanners
"additional_info": { // scanner specific output - structure is different per scan type and could change when scanners are upgraded to new major versions
"key": "value"
}
}
}
}