Skip to content
forgit api docs

Create a hook

POST
/admin/hooks

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json

CreateHookOption options when create a hook

object
active
boolean
authorization_header
string
branch_filter
string
config
required

CreateHookOptionConfig has all config options in it required are “content_type” and “url” Required

object
key
additional properties
string
events
Array<string>
type
required
string
Allowed values: forgejo dingtalk discord gitea gogs msteams slack telegram feishu wechatwork packagist

Responses

Section titled “Responses”

201

Section titled “201”

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