Webhook endpoints

Register a signed webhook endpoint

Requires webhooks:manage. The destination must be credential-free public HTTPS on port 443 and passes DNS/SSRF validation. The signing secret is encrypted at rest and revealed only in this create response. Registration is scoped to the token's account and environment, with at most ten retained endpoint records per environment.

post/v1/webhook-endpoints

Request

  • Base URL: https://scanverity.com
  • URL: https://scanverity.com/v1/webhook-endpoints
  • Auth: HTTP bearer

Request body

urlstring uri required

Credential-free public HTTPS destination on port 443. DNS and address safety are validated at registration and again before every delivery.

eventsWebhookEvent[] required
descriptionstring nullable

Response

Endpoint registered. signing_secret is reveal-once and is never returned by later reads.

endpoint_idstring required
urlstring uri required
descriptionstring nullable required
eventsWebhookEvent[] required
environment'live' | 'sandbox' required
status'enabled' required
created_atstring date-time required
last_success_atstring date-time nullable required
disabled_atunknown required
disabled_reasonunknown required
signing_secretstring required

Reveal-once secret. It is encrypted at rest and omitted from every later response.

Changes

No recorded changes to this operation across all 1 revision of this API.