UpdateWebHook - 更新 WebHook

通过OpenAPI更新WebHook。

适用版本

企业标准版

服务接入点与授权信息

产品

资源

所需权限

代码管理

WebHook

读写

请求语法

PUT https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/webhooks/{hookId}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

60de7a6852743a5162b5f957

repositoryId

string

path

代码库 ID 或者 URL-Encoder 编码的全路径。

2835387

hookId

integer

path

WebHook 主键 ID。

524836

-

object

body

description

string

body

WebHook 描述。

""

enableSslVerification

boolean

body

是否使用 SSL 认证。

true

mergeRequestsEvents

boolean

body

合并请求事件。

true

noteEvents

boolean

body

评论事件。

true

pushEvents

boolean

body

推送事件。

true

tagPushEvents

boolean

body

标签推送事件。

true

token

string

body

用于验证身份的 token,用户自定义。

f0b1e61db5961df5975a93f9129d2513

url

string

body

WebHook 链接,一般不超过1024个字符。

https://xxxxx

请求示例

curl -X 'PUT' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/webhooks/{hookId}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "description": "",
        "enableSslVerification": true,
        "mergeRequestsEvents": true,
        "noteEvents": true,
        "pushEvents": true,
        "tagPushEvents": true,
        "token": "f0b1e61db5961df5975a93f9129d2513",
        "url": "https://xxxxx"
    }'

返回参数

参数

类型

描述

示例值

-

object

createdAt

string

创建时间。

2023-01-03T15:41:26+08:00

description

string

Webhook 描述信息。

""

enableSSLVerification

boolean

是否开启 SSL 认证。

true

id

integer

Webhook 主键 ID。

524836

mergeRequestsEvents

boolean

合并请求事件。

true

noteEvents

boolean

评论事件。

true

pushEvents

boolean

代码推送事件。

true

repositoryId

integer

代码库 ID。

2825387

tagPushEvents

boolean

标签推送事件。

true

token

string

用于验证身份的 token,用户自定义。

f0b1e61db5961df5975a93f9129d2513

updatedAt

string

更新时间。

2023-01-03T15:41:26+08:00

url

string

Webhook 链接。

https://xxxxx

返回示例

{
    "createdAt": "2023-01-03T15:41:26+08:00",
    "description": "",
    "enableSSLVerification": true,
    "id": 524836,
    "mergeRequestsEvents": true,
    "noteEvents": true,
    "pushEvents": true,
    "repositoryId": 2825387,
    "tagPushEvents": true,
    "token": "f0b1e61db5961df5975a93f9129d2513",
    "updatedAt": "2023-01-03T15:41:26+08:00",
    "url": "https://xxxxx"
}

错误码

访问错误码中心查看 API 相关错误码。