gt-webhook-edit(1)

gt-webhook-edit1

Edit a webhook

Usage

gt webhook edit <id> [flags]

Overview

Edit a webhook. Only the settings you pass change.

Gitea drops the stored authorization header of a webhook on every edit and never shows it, so pass it again with --authorization-header-file. On a terminal, gt asks for it instead; leave the answer empty for a webhook without one. Elsewhere, an edit without one of the authorization flags is refused before gt contacts Gitea. Signing secrets cannot be changed: recreate the webhook to rotate one.

Json fields

active, branch_filter, content_type, created_at, events, id, type, updated_at,
url

Options

--active[=false]
Deliver events, or pause the webhook with --active=false

--authorization-header=""
Authorization value (prefer file input)

--authorization-header-file=""
Read authorization value from file or -

--branch-filter=""
Branch glob for push events

--clear-authorization[=false]
Send no authorization header; on edit, this removes the stored one

--config=[]
Adapter-specific configuration, for example channel=alerts

--events=[]
Events that trigger the webhook, comma-separated, replacing the current ones (see gt webhook create --help)

-h, --help[=false]
help for edit

--url=""
Delivery URL

Options inherited from parent commands

--account[=false]
Manage the webhooks of your account

--csv[=""]
Output CSV with the specified comma-separated fields, or all fields

--cwd=""
Working directory for repository discovery

--debug[=false]
Log the method, URL, status, and duration of each HTTP request to stderr

--global[=false]
Manage the system webhooks of the instance (administrators)

--host=""
Gitea instance URL, including any base path

--interactive[=false]
Allow prompts with machine output

-q, --jq=""
Filter JSON output using a jq expression; implies --json

--json[=""]
Output JSON with the specified comma-separated fields, or all fields

--no-input[=false]
Disable prompts and implicit editor/browser interactions

--org=""
Manage the webhooks of an organization

--remote=""
Git remote used for repository discovery

-R, --repo=""
Select a repository as OWNER/REPO or URL

--sudo=""
Perform API requests as this user (requires an administrator account)

--user=""
Account name on the selected instance

Examples

# pause deliveries of a webhook without an authorization header
$ gt webhook edit 3 --active=false --clear-authorization
# keep the authorization header while changing the events
$ gt webhook edit 3 --events push,release --authorization-header-file header.txt

From gitea-cli 1.0.0-1 in Arch Linux 2026-11-07. Parsed by carta from the page's man source.