Update a webhook

PUT
/v1/{namespace}/webhooks/{webhook}

Authorization

headerAuthorizationBearer <token>

A personal or service access token, sent as Authorization: Bearer <token>. See access tokens.

Path Parameters

namespace*string

The namespace id.

webhook*string

The webhook id.

Request Body

application/json
  1. body

A webhook to create or update.

name*string

A display name.

description*string

A free-form description.

url*string

The endpoint events are delivered to.

enabled*boolean

Whether events are delivered.

eventTypes*array<string>

The event types to deliver: exact names, or a prefix followed by .*, e.g. firewall.*. At least one is required.

firewalls*array<string>

Restricts firewall and package events to these firewalls. Empty means every firewall.

Response Body

The updated webhook. Its signing secret is redacted.

application/json
  1. response

A subscription that delivers namespace events to an HTTPS endpoint. Deliveries are signed following the Standard Webhooks convention.

id*string

The webhook id.

name*string

A display name.

description?string

A free-form description.

url*string

The endpoint events are delivered to.

enabled*boolean

Whether events are delivered.

eventTypes*array<string>

The event types delivered: exact names, or a prefix followed by .*, e.g. firewall.*. Event payloads are described by the webhook event schema.

firewalls*array<string>

Restricts firewall and package events to these firewalls. Empty means every firewall. Other events are not affected.

secret?string

The signing secret. Responses show a redaction placeholder.

previousSecret?string

The signing secret before the last rotation, still accepted for 24 hours after it. Responses show a redaction placeholder.

secretRotatedAt?string

When the signing secret was last rotated.

Formatdate-time
quarantinedUntil?string

Set when deliveries kept failing: no events are delivered until this time. Events that occur meanwhile are queued.

Formatdate-time
quarantineReason?string

Why the webhook was quarantined.

createdAt?string

When the webhook was created.

Formatdate-time
updatedAt?string

When the webhook was last changed.

Formatdate-time
curl -X PUT 'https://eu-sov-1.bytesafecloud.eu/v1/my-namespace-id/webhooks/string' \  -H 'Content-Type: application/json' \  -d '{  "description": "Blocked downloads go to the security channel.",  "enabled": true,  "eventTypes": [    "firewall.blocked"  ],  "firewalls": [],  "name": "security alerts",  "url": "https://hooks.example.com/firewall"}'
{  "id": "whep-01K6Z3Q8R9T2V4X6Y8A0C2E4G6",  "name": "security alerts",  "url": "https://hooks.example.com/firewall",  "enabled": true,  "eventTypes": [    "firewall.blocked"  ],  "firewalls": [],  "secret": "1F56ED4E-D401-49E4-B40C-0B7B8411BAD6",  "createdAt": "2026-03-02T09:30:00Z",  "updatedAt": "2026-03-02T09:30:00Z"}