Update a webhook

PATCH

/api/v1/webhooks/{webhook_id}

Parameters

Path Parameters

webhook_id

required

Webhook Id

string format: uuid

Request Body ^required

WebhookUpdateRequest

Request body for PATCH /api/v1/webhooks/{id}. All fields optional.

object

name

Any of:

string

string

<= 255 characters

null

null

url

Any of:

string

string format: uri

>= 1 characters <= 2083 characters

null

null

events

Any of:

Array<string>

Array<string>

>= 1 items

Allowed values: execution.completed execution.failed storage.object.created

null

null

filter

Any of:

WebhookFilter

WebhookFilter

Optional metadata filter applied to events before delivery.

All fields are optional. When multiple fields are set, they combine with AND. Events that lack the filter’s target field are excluded (not matched). For example, a webhook with stage set receives only storage events with a matching sidecar stage; it does not receive execution events.

object

stage

Any of:

string

string

null

null

tag_pattern

Any of:

string

string

null

null

extension

Any of:

string

string

null

null

route_id

Any of:

string

string

null

null

null

null

secret

Any of:

string

string

null

null

description

Any of:

string

string

null

null

is_active

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

WebhookResponse

Webhook row as returned from the API. Secret is never echoed.

object

id

required

Id

Webhook id (UUID v7).

string format: uuid

name

required

Name

Human-readable webhook name.

string

url

required

Url

Destination URL for POST delivery.

string format: uri

>= 1 characters <= 2083 characters

events

required

Events

Event types this webhook receives.

Array<string>

Allowed values: execution.completed execution.failed storage.object.created

filter

Any of:

object

object

key

additional properties

any

null

null

description

Any of:

string

string

null

null

is_active

required

Is Active

Whether this webhook is currently delivering.

boolean

has_secret

required

Has Secret

True when a signing secret is configured.

boolean

created_at

required

Created At

When the webhook was registered.

string format: date-time

updated_at

required

Updated At

When the webhook was last modified.

string format: date-time

created_by

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object