PgBeam Docs
webhooks

webhooks update

Update a webhook endpoint

Update the configuration of an existing webhook endpoint. Only the fields you provide are changed; current settings are preserved for any flag not specified. Use --event to replace the subscribed event types (comma-separated) and --enabled to toggle delivery.

Usage

pgbeam webhooks update <id> [flags]

Options

OptionDescriptionRequiredDefault
<id>ID of the webhook endpoint to updateYes-
--url <value>New destination URL for webhook deliveries.No-
--format <value>New delivery format: json, splunk_hec, datadog, or elastic.No-
--event <value>Replace subscribed event type(s). Comma-separated.No-
--secret <value>New shared secret used to sign webhook payloads.No-
--description <value>New human-readable description for the webhook endpoint.No-
--enabledEnable (true) or disable (false) the webhook endpoint.No-

Global options

All global options (--token, --profile, --project, --org, --json, --no-color, --debug) are also available on this command.

Examples

# Change a webhook's URL
pgbeam webhooks update wh_xxx --url https://new.example.com/hook

# Subscribe a webhook to specific events
pgbeam webhooks update wh_xxx --event query.blocked,policy.updated

# Disable a webhook
pgbeam webhooks update wh_xxx --enabled=false

Output

Prints a success message confirming the webhook was updated. With --json, returns the full updated webhook object from the API.

On this page