GiteaHat
  1. repository
GiteaHat
  • Gitea接口
    • activitypub
      • Returns the Person actor for a user
      • Send to the inbox
    • admin
      • List cron tasks
      • Run cron task
      • List all organizations
      • List unadopted repositories
      • Adopt unadopted files as a repository
      • Delete unadopted files
      • Search users according filter conditions
      • Create a user
      • Delete a user
      • Edit an existing user
      • Add a public key on behalf of a user
      • Delete a user's public key
      • Create an organization
      • Create a repository on behalf of a user
    • miscellaneous
      • Render a markdown document as HTML
      • Render raw markdown as HTML
      • Returns the nodeinfo of the Gitea application
      • Get default signing-key.gpg
      • Returns the version of the Gitea application
    • notification
      • List users's notification threads
      • Mark notification threads as read, pinned or unread
      • Check if unread notifications exist
      • Get notification thread by ID
      • Mark notification thread as read by ID
      • List users's notification threads on a specific repo
      • Mark notification threads as read, pinned or unread on a specific repo
    • organization
      • Create a repository in an organization
      • Get list of organizations
      • Create an organization
      • Get an organization
      • Delete an organization
      • Edit an organization
      • List an organization's webhooks
      • Create a hook
      • Get a hook
      • Delete a hook
      • Update a hook
      • List an organization's labels
      • Create a label for an organization
      • Get a single label
      • Delete a label
      • Update a label
      • List an organization's members
      • Check if a user is a member of an organization
      • Remove a member from an organization
      • List an organization's public members
      • Check if a user is a public member of an organization
      • Publicize a user's membership
      • Conceal a user's membership
      • List an organization's repos
      • Create a repository in an organization
      • List an organization's teams
      • Create a team
      • Search for teams within an organization
      • Get a team
      • Delete a team
      • Edit a team
      • List a team's members
      • List a particular member of team
      • Add a team member
      • Remove a team member
      • List a team's repos
      • List a particular repo of team
      • Add a repository to a team
      • Remove a repository from a team
      • List the current user's organizations
      • List a user's organizations
      • Get user permissions in organization
    • package
      • Gets all packages of an owner
      • Gets a package
      • Delete a package
      • Gets all files of a package
    • issue
      • Search for issues across the repositories that the user has access to
      • List a repository's issues
      • Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
      • List all comments in a repository
      • Get a comment
      • Delete a comment
      • Edit a comment
      • Get a list of reactions from a comment of an issue
      • Add a reaction to a comment of an issue
      • Remove a reaction from a comment of an issue
      • Get an issue
      • Delete an issue
      • Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
      • List all comments on an issue
      • Add a comment to an issue
      • Delete a comment
      • Edit a comment
      • Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
      • Get an issue's labels
      • Replace an issue's labels
      • Add a label to an issue
      • Remove all labels from an issue
      • Remove a label from an issue
      • Get a list reactions of an issue
      • Add a reaction to an issue
      • Remove a reaction from an issue
      • Delete an issue's existing stopwatch.
      • Start stopwatch on an issue.
      • Stop an issue's existing stopwatch.
      • Get users who subscribed on an issue.
      • Check if user is subscribed to an issue
      • Subscribe user to issue
      • Unsubscribe user from issue
      • List all comments and events on an issue
      • List an issue's tracked times
      • Add tracked time to a issue
      • Reset a tracked time of an issue
      • Delete specific tracked time
      • Get all of a repository's labels
      • Create a label
      • Get a single label
      • Delete a label
      • Update a label
      • Get all of a repository's opened milestones
      • Create a milestone
      • Get a milestone
      • Delete a milestone
      • Update a milestone
    • repository
      • Migrate a remote git repository
        POST
      • Search for repositories
        GET
      • Get a repository
        GET
      • Delete a repository
        DELETE
      • Edit a repository's properties. Only fields that are set will be changed.
        PATCH
      • Get an archive of a repository
        GET
      • Return all users that have write access and can be assigned to issues
        GET
      • List branch protections for a repository
        GET
      • Create a branch protections for a repository
        POST
      • Get a specific branch protection for the repository
        GET
      • Delete a specific branch protection for the repository
        DELETE
      • Edit a branch protections for a repository. Only fields that are set will be changed
        PATCH
      • List a repository's branches
        GET
      • Create a branch
        POST
      • Retrieve a specific branch from a repository, including its effective branch protection
        GET
      • Delete a specific branch from a repository
        DELETE
      • List a repository's collaborators
        GET
      • Check if a user is a collaborator of a repository
        GET
      • Add a collaborator to a repository
        PUT
      • Delete a collaborator from a repository
        DELETE
      • Get repository permissions for a user
        GET
      • Get a list of all commits from a repository
        GET
      • Get a commit's combined status, by branch/tag/commit reference
        GET
      • Get a commit's statuses, by branch/tag/commit reference
        GET
      • Gets the metadata of all the entries of the root dir
        GET
      • Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
        GET
      • Update a file in a repository
        PUT
      • Create a file in a repository
        POST
      • Delete a file in a repository
        DELETE
      • Apply diff patch to repository
        POST
      • Get the EditorConfig definitions of a file in a repository
        GET
      • List a repository's forks
        GET
      • Fork a repository
        POST
      • Gets the blob of a repository.
        GET
      • Get a single commit from a repository
        GET
      • Get a commit's diff or patch
        GET
      • Get a note corresponding to a single commit from a repository
        GET
      • Get specified ref or filtered repository's refs
        GET
      • Get specified ref or filtered repository's refs
        GET
      • Gets the tag object of an annotated tag (not lightweight tags)
        GET
      • Gets the tree of a repository.
        GET
      • List the hooks in a repository
        GET
      • Create a hook
        POST
      • List the Git hooks in a repository
        GET
      • Get a Git hook
        GET
      • Delete a Git hook in a repository
        DELETE
      • Edit a Git hook in a repository
        PATCH
      • Get a hook
        GET
      • Delete a hook in a repository
        DELETE
      • Edit a hook in a repository
        PATCH
      • Test a push webhook
        POST
      • Get available issue templates for a repository
        GET
      • List a repository's keys
        GET
      • Add a key to a repository
        POST
      • Get a repository's key by id
        GET
      • Delete a key from a repository
        DELETE
      • Get languages and number of bytes of code written
        GET
      • Get a file or it's LFS object from a repository
        GET
      • Sync a mirrored repository
        POST
      • List a repo's pull requests
        GET
      • Create a pull request
        POST
      • Get a pull request
        GET
      • Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
        PATCH
      • Get a pull request diff or patch
        GET
      • Get commits for a pull request
        GET
      • Check if a pull request has been merged
        GET
      • Merge a pull request
        POST
      • Cancel the scheduled auto merge for the given pull request
        DELETE
      • create review requests for a pull request
        POST
      • cancel review requests for a pull request
        DELETE
      • List all reviews for a pull request
        GET
      • Create a review to an pull request
        POST
      • Get a specific review for a pull request
        GET
      • Submit a pending review to an pull request
        POST
      • Delete a specific review from a pull request
        DELETE
      • Get a specific review for a pull request
        GET
      • Dismiss a review for a pull request
        POST
      • Cancel to dismiss a review for a pull request
        POST
      • Merge PR's baseBranch into headBranch
        POST
      • Get all push mirrors of the repository
        GET
      • add a push mirror to the repository
        POST
      • Sync all push mirrored repository
        POST
      • Get push mirror of the repository by remoteName
        GET
      • deletes a push mirror from a repository by remoteName
        DELETE
      • Get a file from a repository
        GET
      • List a repo's releases
        GET
      • Create a release
        POST
      • Get changed files for a pull request
        GET
      • Get a release by tag name
        GET
      • Delete a release by tag name
        DELETE
      • Get a release
        GET
      • Delete a release
        DELETE
      • Update a release
        PATCH
      • List release's attachments
        GET
      • Create a release attachment
        POST
      • Get a release attachment
        GET
      • Delete a release attachment
        DELETE
      • Edit a release attachment
        PATCH
      • Return all users that can be requested to review in this repo
        GET
      • Get signing-key.gpg for given repository
        GET
      • List a repo's stargazers
        GET
      • Get a commit's statuses
        GET
      • Create a commit status
        POST
      • List a repo's watchers
        GET
      • Check if the current user is watching a repo
        GET
      • Watch a repo
        PUT
      • Unwatch a repo
        DELETE
      • List a repository's tags
        GET
      • Create a new git tag in a repository
        POST
      • Get the tag of a repository by tag name
        GET
      • Delete a repository's tag by name
        DELETE
      • List a repository's teams
        GET
      • Check if a team is assigned to a repository
        GET
      • Add a team to a repository
        PUT
      • Delete a team from a repository
        DELETE
      • List a repo's tracked times
        GET
      • List a user's tracked times in a repo
        GET
      • Get list of topics that a repository has
        GET
      • Replace list of topics for a repository
        PUT
      • Add a topic to a repository
        PUT
      • Delete a topic from a repository
        DELETE
      • Transfer a repo ownership
        POST
      • Accept a repo transfer
        POST
      • Reject a repo transfer
        POST
      • Create a wiki page
        POST
      • Get a wiki page
        GET
      • Delete a wiki page
        DELETE
      • Edit a wiki page
        PATCH
      • Get all wiki pages
        GET
      • Get revisions of a wiki page
        GET
      • Create a repository using a template
        POST
      • Get a repository by id
        GET
      • search topics via keyword
        GET
      • Create a repository
        POST
    • settings
      • Get instance's global settings for api
      • Get instance's global settings for Attachment
      • Get instance's global settings for repositories
      • Get instance's global settings for ui
    • user
      • Get the authenticated user
      • List the authenticated user's oauth2 applications
      • creates a new OAuth2 application
      • get an OAuth2 Application
      • delete an OAuth2 Application
      • update an OAuth2 Application, this includes regenerating the client secret
      • List the authenticated user's email addresses
      • Add email addresses
      • Delete email addresses
      • List the authenticated user's followers
      • List the users that the authenticated user is following
      • Check whether a user is followed by the authenticated user
      • Follow a user
      • Unfollow a user
      • Get a Token to verify
      • Verify a GPG key
      • List the authenticated user's GPG keys
      • Create a GPG key
      • Get a GPG key
      • Remove a GPG key
      • List the authenticated user's public keys
      • Create a public key
      • Get a public key
      • Delete a public key
      • List the repos that the authenticated user owns
      • Get user settings
      • Update user settings
      • The repos that the authenticated user has starred
      • Whether the authenticated is starring the repo
      • Star the given repo
      • Unstar the given repo
      • Get list of all existing stopwatches
      • List repositories watched by the authenticated user
      • List all the teams a user belongs to
      • List the current user's tracked times
      • Search for users
      • Get a user
      • List the given user's followers
      • List the users that the given user is following
      • Check if one user is following another user
      • List the given user's GPG keys
      • Get a user's heatmap
      • List the given user's public keys
      • List the repos owned by the given user
      • The repos that the given user has starred
      • List the repositories watched by a user
      • List the authenticated user's access tokens
      • Create an access token
      • delete an access token
  • Hat拓展接口
    • repository
      • actions
        • 获取流水线文件列表
        • 获取流水线任务列表
        • 重新启动流水线任务
        • 重新启动全部流水线任务
        • 禁用流水线
        • 恢复流水线
        • 下载流水线日志
        • 启动流水线任务
      • 获取仓库所有文件文件夹
      • 获取仓库路径下所有文件文件夹
      • 仓库内搜索文件
      • 获取单个commit内容
      • 获取单个commit的dif内容
      • 创建一个webhook
      • 获取一个webhook推送历史
      • Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at
      • 获取所有的发行版
      • 获取一个发行版
      • 创建一个发行版
      • 更新一个发行版
      • 获取所有分支名称
      • 获取所有分支 (按类型分组)
      • 获取所有标签名称
      • 获取所有标签
      • 获取仓库分支、标签数量
      • 获取仓库readme文件内容
      • 获取仓库目录下readme文件内容
      • 获取所有commits（按时间分组）
      • 获取仓库贡献者
      • 获取仓库commit数量、标签数量、分支数量、发行版数量（按分支）
      • 获取文件或文件夹下的commit列表
      • 获取仓库blame内容
      • 分支、标签、commit的比较接口
      • 迁移项目（直接）
      • 获取一个合并请求
      • 获取合并请求下的commit列表
      • Get changed files for a pull request
      • 仓库下批量更改文件（创建、更新、删除）
      • 获取合并请求下所有版本记录
      • 获取合并请求下一个版本记录的diff内容
      • 获取仓库代码贡献情况
      • 获取所有分支
      • 获取仓库贡献者（包括代码行）
      • 恢复一个已删除分支
      • 获取最近的commit列表
      • 删除一个仓库
    • organization
      • 创建一个组织
      • 团队添加所有组织项目
      • 团队移除所有组织项目
      • 编辑一个组织
    • users
      • 获取用户贡献记录（按时间）
    • admin
      • 编辑一个用户
  1. repository

Create a hook

POST
/repos/{owner}/{repo}/hooks

请求参数

Authorization
在 Header 添加参数
Authorization
，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password
示例：
Authorization: Basic *****************
Path 参数
owner
string 
必需
owner of the repo
repo
string 
必需
name of the repo
Body 参数application/json
CreateHookOption options when create a hook
active
boolean 
可选
默认值:
false
authorization_header
string 
可选
branch_filter
string 
可选
config
object (CreateHookOptionConfig) 
必需
CreateHookOptionConfig has all config options in it
required are "content_type" and "url" Required
额外字段
string 
可选
events
array[string]
可选
type
enum<string> 
必需
枚举值:
dingtalkdiscordgiteagogsmsteamsslacktelegramfeishuwechatworkpackagist
示例
{
    "active": false,
    "authorization_header": "string",
    "branch_filter": "string",
    "config": {
        "property1": "string",
        "property2": "string"
    },
    "events": [
        "string"
    ],
    "type": "dingtalk"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/repos///hooks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "active": false,
    "authorization_header": "string",
    "branch_filter": "string",
    "config": {
        "property1": "string",
        "property2": "string"
    },
    "events": [
        "string"
    ],
    "type": "dingtalk"
}'

返回响应

🟢201成功
application/json
Body
Hook a hook is a web hook when one repository changed
active
boolean 
可选
authorization_header
string 
可选
branch_filter
string 
可选
config
object 
可选
额外字段
string 
可选
created_at
string <date-time>
可选
events
array[string]
可选
id
integer <int64>
可选
type
string 
可选
updated_at
string <date-time>
可选
示例
{
    "active": true,
    "authorization_header": "string",
    "branch_filter": "string",
    "config": {
        "property1": "string",
        "property2": "string"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "events": [
        "string"
    ],
    "id": 0,
    "type": "string",
    "updated_at": "2019-08-24T14:15:22Z"
}
🟠404404
修改于 2024-03-15 02:18:17
上一页
List the hooks in a repository
下一页
List the Git hooks in a repository
Built with