Skip to main content
PATCH
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.

Path Parameters

webhookId
string<uuid>
required

UUID of the webhook. Use the id field of a webhook from listWebhooks.

Body

application/json

At least one of url, events, is_active, business_unit, or rotate_secret must be provided.

url
string<uri>

New HTTPS endpoint that receives the signed webhook deliveries.

events
enum<string>[]

Full replacement list of event names to subscribe to. Use * to receive every event.

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

Set to a string to restrict deliveries to that business_unit (requires the Enterprise plan), or null to clear the scope (organization-wide).

is_active
boolean

Set to false to pause deliveries, or true to resume them.

rotate_secret
boolean

If true, generate and return a new signing secret.

Response

Webhook updated. Includes secret if rotate_secret was true.

webhook
object
required
secret
string

New signing secret, only present when rotate_secret was true.