Skip to main content
POST
Create a webhook endpoint

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string<uri>
required
event_types
enum<string>[]
required
Minimum array length: 1
Available options:
scan.started,
scan.completed,
scan.failed,
vulnerability.found,
vulnerability.status_changed,
repository.scan_completed,
schedule.triggered
description
string
Maximum string length: 255

Response

Success

object
string
required
Allowed value: "webhook_endpoint"
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
url
string
required
description
string | null
required
enabled
boolean
required
event_types
string[]
required
created_at
string
required
secret
string