Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Body

application/json
url
string<uri>
required

HTTPS endpoint that receives the signed webhook deliveries.

events
enum<string>[]
required

Event names to subscribe to. Use * to receive every event.

Minimum array length: 1
Available options:
scan.created,
scan.completed,
scan.failed,
scan.cancelled,
vulnerability.created,
vulnerability.status_changed,
vulnerability.severity_changed,
*
business_unit
string | null

Optional. Restrict deliveries to events whose asset carries this business_unit. Requires the Enterprise plan. Omit or null for an organization-wide subscription.

is_active
boolean
default:true

When false, the webhook is stored but no deliveries are sent.

Response

Webhook created.

webhook
object
required
secret
string
required

Webhook signing secret. Only returned at creation time.