Get a hook

GET

/user/hooks/{id}

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

id

required

integer format: int64

Id of the hook to get

Responses

200

Hook

Media type application/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

Example ^generated

{
  "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"
}

401

APIUnauthorizedError is a unauthorized error response

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

403

APIForbiddenError is a forbidden error response

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}