Skip to content
forgit api docs

Update a hook

PATCH
/orgs/{org}/hooks/{id}

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Name of the organization

id
required
integer format: int64

Id of the hook to update

Request Body

Section titled “Request Body”
Media typeapplication/json

EditHookOption options when modify one hook

object
active
boolean
authorization_header
string
branch_filter
string
config
object
key
additional properties
string
events
Array<string>
Examplegenerated
{
  "active": true,
  "authorization_header": "example",
  "branch_filter": "example",
  "config": {
    "additionalProperty": "example"
  },
  "events": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Hook

Media typeapplication/json

Hook a hook is a web hook when one repository changed

object
active
boolean
authorization_header
string
branch_filter
string
config

Deprecated: use Metadata instead

object
key
additional properties
string
content_type
string
created_at
string format: date-time
events
Array<string>
id
integer format: int64
metadata
type
string
updated_at
string format: date-time
url
string
Examplegenerated
{
  "active": true,
  "authorization_header": "example",
  "branch_filter": "example",
  "config": {
    "additionalProperty": "example"
  },
  "content_type": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "events": [
    "example"
  ],
  "id": 1,
  "metadata": "example",
  "type": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "url": "example"
}

404

Section titled “404”

APINotFound is a not found error response

Media typeapplication/json
object
errors
Array<string>
message
string
url
string
Examplegenerated
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}