文档

AddWebhook - 创建代码库Webhook

更新时间:

创建代码库Webhook。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /repository/{repositoryId}/webhooks/create

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 ID,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

60de7a6852743a5162b5f957
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdlong

代码库 ID

2835387
bodyobject

请求 Body

urlstring

Webhook 链接 URL

https://xxxxx
pushEventsboolean

是否订阅分支推送事件 可选值:true / false

true
mergeRequestsEventsboolean

是否订阅合并请求事件 可选值:true / false

true
tagPushEventsboolean

是否订阅标签推送事件 可选值:true / false

false
noteEventsboolean

是否订阅评论事件 可选值:true / false

false
enableSslVerificationboolean

使用 SSL 认证 可选值:true / false

false
descriptionstring

webhook 描述

线下测试
secretTokenstring

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

xxxx

返回参数

名称类型描述示例值
object

Schema of Response

errorMessagestring

错误信息

“”
requestIdstring

请求 ID

6177543A-8D54-5736-A93B-E0195A1512CB
errorCodestring

错误码

SYSTEM_NOT_FOUND_ERROR
successboolean

调用是否成功

true
resultobject

结果。

pushEventsboolean

是否订阅分支推送事件 可选值:true / false

true
repositoryIdlong

代码库 ID

2835387
createdAtstring

创建时间

2022-03-12 12:00:00
urlstring

webhook 链接 URL

https://xxxxx
tagPushEventsboolean

是否订阅标签推送事件 可选值:true / false

true
lastTestResultstring

最后执行结果 可选值:ok / error / ""(空字符串)

ok
descriptionstring

描述信息

线下测试
mergeRequestsEventsboolean

是否订阅合并请求事件 可选值:true / false

true
secretTokenstring

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

xxxx
noteEventsboolean

是否订阅评论事件 可选值:true / false

false
idlong

webhook 唯一标识

30815
enableSslVerificationboolean

是否使用 SSL 认证 可选值:true / false

false

示例

正常返回示例

JSON格式

{
  "errorMessage": "“”",
  "requestId": "6177543A-8D54-5736-A93B-E0195A1512CB",
  "errorCode": "SYSTEM_NOT_FOUND_ERROR",
  "success": true,
  "result": {
    "pushEvents": true,
    "repositoryId": 2835387,
    "createdAt": "2022-03-12 12:00:00",
    "url": "https://xxxxx",
    "tagPushEvents": true,
    "lastTestResult": "ok",
    "description": "线下测试",
    "mergeRequestsEvents": true,
    "secretToken": "xxxx",
    "noteEvents": false,
    "id": 30815,
    "enableSslVerification": false
  }
}

错误码

HTTP status code错误码错误信息
500SystemError.UnKnownErrorAn error occurred while processing your request.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:organizationId
    新增入参:accessToken
    删除入参:OrganizationId
    删除入参:AccessToken
  • 本页导读 (0)