创建代码库Webhook。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /api/v3/projects/{ProjectId}/hooks HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
AccessToken | String | Query | 否 | 146dd344827fe2444f952e931e51xxxx | 个人访问令牌。 使用阿里云AK+SK或使用STS临时授权方式不需要传该字段 |
ProjectId | Long | Path | 是 | 100 | 代码库ID |
OrganizationId | String | Query | 是 | 60811b5eed6e867404f6xxxx | 企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/ |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorMessage | String | 代码库不存在 | 错误信息 |
RequestId | String | ABCD-EFG-HIJK | 请求ID |
ErrorCode | String | NOT_FOUND | 错误码 |
Success | Boolean | true | 成功状态 |
Result | Object | 结果数据 |
|
PushEvents | Boolean | true | 分支推送事件 |
BuildEvents | Boolean | false | 构建事件(已废弃) |
ProjectId | Long | 100 | 代码库 Id |
CreatedAt | String | 2020-11-13T10:50:32.167+08:00 | 创建时间 |
Url | String | https://xxxxxx | Webhook url 回调地址 |
IssuesEvents | Boolean | false | Issue事件(已废弃) |
TagPushEvents | Boolean | true | 标签推送事件 |
LastTestResult | String | xxx | 最后执行结果 |
Description | String | xxx | 描述 |
MergeRequestsEvents | Boolean | true | 合并请求事件 |
SecretToken | String | xxxxx | Webhook合法性验证Token |
NoteEvents | Boolean | true | 评论事件 |
Id | Long | 100 | Webhook Id |
EnableSslVerification | Boolean | false | 使用SSL认证 |
示例
请求示例
POST /api/v3/projects/[ProjectId]/hooks HTTP/1.1
公共请求头
```json
{
"OrganizationId": "60811b5eed6e867404f6xxxx",
"ProjectId": "100"
}
```
请求体
```json
{
"url": "http://example.com",
"push_events": true,
"merge_requests_events": true,
"tag_push_events": true,
"note_events": true,
"enable_ssl_verification": false,
"description": "desc",
"secret_token": ""
}
```
**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 | 描述 | 否 | |
| secret_token | string | Webhook合法性验证Token | 否 | |
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RequestId>ABCD-EFG-HIJK</RequestId>
<ErrorCode>NOT_FOUND</ErrorCode>
<ErrorMessage>代码库不存在</ErrorMessage>
<Success>true</Success>
<Result>
<Description/>
<PushEvents/>
<CreatedAt/>
<ProjectId/>
<TagPushEvents/>
<IssuesEvents/>
<MergeRequestsEvents/>
<Url/>
<LastTestResult/>
<BuildEvents/>
<EnableSslVerification/>
<Id/>
<NoteEvents/>
<SecretToken/>
</Result>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "ABCD-EFG-HIJK",
"ErrorCode" : "NOT_FOUND",
"ErrorMessage" : "代码库不存在",
"Success" : "true",
"Result" : {
"Description" : "",
"PushEvents" : "",
"CreatedAt" : "",
"ProjectId" : "",
"TagPushEvents" : "",
"IssuesEvents" : "",
"MergeRequestsEvents" : "",
"Url" : "",
"LastTestResult" : "",
"BuildEvents" : "",
"EnableSslVerification" : "",
"Id" : "",
"NoteEvents" : "",
"SecretToken" : ""
}
}
错误码
访问错误中心查看更多错误码。