scan.completed

POST

A scan finished. Includes issue counts by severity. Subscribing needs the scans:read scope.

Parameters

Header Parameters

X-DevSecure-Signature

required

string

T=,v1=<hex HMAC-SHA256 of “.”>[,v1=…]

X-DevSecure-Event

required

string

The event type.

X-DevSecure-Event-Id

required

string

The event id; the same on every retry and redelivery.

X-DevSecure-Delivery

required

string

The delivery id.

X-DevSecure-Webhook-Id

required

string

The webhook subscription id.

Request Body^required

Media typeapplication/json

object

id

required

Event id.

string format: uuid

type

required

string

Allowed value: scan.completed

api_version

required

string

Allowed value: v1

created_at

required

string format: date-time

data

required

object

scan

required

ScanDetail

object

id

required

Id

string

type

required

Type

string

Allowed values: code upload dast container pentest cms other

provider

Any of:

string

string

Allowed values: github gitlab bitbucket

null

null

title

Any of:

string

string

null

null

description

Any of:

string

string

null

null

status

required

Status

string

Allowed values: queued running completed failed unknown

error_code

Any of:

string

string

null

null

environment

Any of:

string

string

Allowed values: prod staging dev

null

null

repository

Any of:

ScanRepository

ScanRepository

object

id

required

Id

string

provider

required

Provider

string

Allowed values: github gitlab bitbucket container

name

required

Name

string

null

null

target

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

completed_at

Any of:

string

string

null

null

issue_counts

required

SeverityCounts

Every issue the scan found, by severity.

object

critical

Critical

integer

0

high

High

integer

0

medium

Medium

integer

0

low

Low

integer

0

info

Info

integer

0

total

Total

integer

0

status_counts

required

IssueStatusCounts

object

open

Open

integer

0

resolved

Resolved

integer

0

snoozed

Snoozed

integer

0

false_positive

False Positive

integer

0

accepted_risk

Accepted Risk

integer

0

Responses

410

Gone: DevSecure turns the webhook off.

2XX

Received. Any 2xx status counts as delivered.

default

Anything else (or no answer in 10 s) is retried.