mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +00:00
bircni
55c3a392a1
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
74 lines
3.0 KiB
Markdown
74 lines
3.0 KiB
Markdown
---
|
|
sidebar_position: 3
|
|
description: "Edit a webhook"
|
|
---
|
|
|
|
# gt webhook edit
|
|
|
|
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
|
|
|
Edit a webhook
|
|
|
|
## Synopsis
|
|
|
|
```text
|
|
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.
|
|
```
|
|
|
|
```
|
|
gt webhook edit <id> [flags]
|
|
```
|
|
|
|
## 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
|
|
```
|
|
|
|
## Options
|
|
|
|
```
|
|
--active Deliver events, or pause the webhook with --active=false
|
|
--authorization-header string Authorization value (prefer file input)
|
|
--authorization-header-file string Read authorization value from file or -
|
|
--branch-filter string Branch glob for push events
|
|
--clear-authorization Send no authorization header; on edit, this removes the stored one
|
|
--config stringToString Adapter-specific configuration, for example channel=alerts (default [])
|
|
--events strings Events that trigger the webhook, comma-separated, replacing the current ones (see gt webhook create --help)
|
|
-h, --help help for edit
|
|
--url string Delivery URL
|
|
```
|
|
|
|
## Options inherited from parent commands
|
|
|
|
```
|
|
--account Manage the webhooks of your account
|
|
--cwd directory Working directory for repository discovery
|
|
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
|
--global Manage the system webhooks of the instance (administrators)
|
|
--host URL Gitea instance URL, including any base path
|
|
--interactive Allow prompts with machine output
|
|
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
|
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
|
--no-input Disable prompts and implicit editor/browser interactions
|
|
--org string Manage the webhooks of an organization
|
|
--remote remote Git remote used for repository discovery
|
|
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
|
--sudo user Perform API requests as this user (requires an administrator account)
|
|
--user name Account name on the selected instance
|
|
-y, --yes Accept confirmations without prompting
|
|
```
|
|
|
|
## SEE ALSO
|
|
|
|
* [gt webhook](../webhook/index.md): Manage webhooks
|