Update a webhook

PATCH

webhooks

{webhookId}

Error

A valid request URL is required to generate request examples

{
  "webhook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [],
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "organization_id": "<string>",
    "business_unit": "<string>",
    "secret_prefix": "<string>",
    "last_success_at": "2023-11-07T05:31:56Z",
    "last_failure_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "secret": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

webhookId

string<uuid>

required

Body

application/json

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

url

string<uri>

events

enum<string>[]

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

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

Show child attributes

secret

string

New signing secret, only present when rotate_secret was true.

List webhook deliveriesReturns a paginated delivery log for a specific webhook.

Error

A valid request URL is required to generate request examples

{
  "webhook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [],
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "organization_id": "<string>",
    "business_unit": "<string>",
    "secret_prefix": "<string>",
    "last_success_at": "2023-11-07T05:31:56Z",
    "last_failure_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "secret": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

Update a webhook

Authorizations

Path Parameters

Body

Response