创建代码库Webhook。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /repository/{repositoryId}/webhooks/create
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业ID,字符串形式,可在云效访问链接中获取,如https://devops.aliyun.com/organization/【OrganizationId】 | 60de7a6852743a5162b5f957 |
accessToken | string | 否 | 个人访问令牌。 使用阿里云AK+SK或使用STS临时授权方式不需要传该字段 | f0b1e61db5961df5975a93f9129d2513 |
repositoryId | long | 是 | 代码库ID | 2835387 |
body | object | 是 | 请求Body | |
url | string | 是 | Webhook链接URL | https://xxxxx |
pushEvents | boolean | 否 | 是否订阅分支推送事件 可选值:true / false | true |
mergeRequestsEvents | boolean | 否 | 是否订阅合并请求事件 可选值:true / false | true |
tagPushEvents | boolean | 否 | 是否订阅标签推送事件 可选值:true / false | false |
noteEvents | boolean | 否 | 是否订阅评论事件 可选值:true / false | false |
enableSslVerification | boolean | 否 | 使用SSL认证 可选值:true / false | false |
description | string | 否 | webhook描述 | 线下测试 |
secretToken | string | 否 | 用于验证身份的Token,用户自定义 | xxxx |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 |
---|---|---|
500 | SystemError.UnKnownError | An error occurred while processing your request. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2022-11-21 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
|