全部产品

添加代码库 Webhook

该接口用于在代码库中添加一条 Webhook

请求方式POST/api/v3/projects/[ProjectId]/hooks

请求Action:AddWebhook

请求 body

{
    "url": "http://example.com",
    "push_events": true,
    "merge_requests_events": true,
 "tag_push_events": true,
 "note_evnets": true,
 "enable_ssl_verification": false,
 "description": "desc",
}

body参数说明

参数名

类型

说明

是否必须

默认值

url

string

Webhook url

push_events

boolean

分支推送事件

true

merge_reqeusts_events

boolean

合并请求事件

false

tag_push_events

boolean

标签推送事件

false

note_events

boolean

评论事件

false

enable_ssl_verification

boolean

使用认证

true

description

string

描述

返回 body :

{
   "ErrorCode": "",
   "ErrorMessage": "",
   "RequestId": "",
   "Success":true,
   "Result": {
  "Id": 100,
  "Url": "http://example.com",
  "CreatedAt": "2020-11-13T10:50:32.167+08:00",
  "ProjectId": 500,
  "PushEvents": true,
  "MergeRequestsEvents": true,
  "TagPushEvents": true,
  "NoteEvents": true,
  "EnableSslVerification": true,
  "LastTestResult": "",
  "Description": ""
 }
}

返回结果说明:

参数名

类型

说明

Id

long

Webhook Id

Url

string

Webhook url 回调地址

CreatedAt

string

创建时间

ProjectId

long

代码库 Id

PushEvents

boolean

分支推送事件

MergeRequestsEvents

boolean

合并请求事件

TagPushEvents

boolean

标签推送事件

NoteEvents

boolean

评论事件

EnableSslVerification

boolean

使用SSL认证

LastTestResult

string

最后执行结果

Description

string

描述