存储库 Webhook 交付

使用 REST API 与存储库 Webhook 的交付进行交互。

List deliveries for a repository webhook

Returns a list of webhook deliveries for a webhook configured in a repository.

参数

标头
名称, 类型, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner`string必须 The account owner of the repository. The name is not case sensitive.
`repo`string必须 The name of the repository. The name is not case sensitive.
`hook_id`integer必须 The unique identifier of the hook.
查询参数
名称, 类型, 说明
`per_page`integer The number of results per page (max 100). 默认: `30`
`cursor`string Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.
`redelivery`boolean

HTTP 响应状态代码

状态代码	说明
`200`	OK
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

代码示例

get/repos/{owner}/{repo}/hooks/{hook_id}/deliveries

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveries

Response

Status: 200

[
  {
    "id": 12345678,
    "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
    "delivered_at": "2019-06-03T00:57:16Z",
    "redelivery": false,
    "duration": 0.27,
    "status": "OK",
    "status_code": 200,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 456
  },
  {
    "id": 123456789,
    "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
    "delivered_at": "2019-06-04T00:57:16Z",
    "redelivery": true,
    "duration": 0.28,
    "status": "OK",
    "status_code": 200,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 456
  }
]

Get a delivery for a repository webhook

适用于 GitHub Apps

Returns a delivery for a webhook configured in a repository.

参数

标头
名称, 类型, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner`string必须 The account owner of the repository. The name is not case sensitive.
`repo`string必须 The name of the repository. The name is not case sensitive.
`hook_id`integer必须 The unique identifier of the hook.
`delivery_id`integer必须

HTTP 响应状态代码

状态代码	说明
`200`	OK
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

代码示例

get/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveries/DELIVERY_ID

Response

Status: 200

{
  "id": 12345678,
  "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
  "delivered_at": "2019-06-03T00:57:16Z",
  "redelivery": false,
  "duration": 0.27,
  "status": "OK",
  "status_code": 200,
  "event": "issues",
  "action": "opened",
  "installation_id": 123,
  "repository_id": 456,
  "url": "https://www.example.com",
  "request": {
    "headers": {
      "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
      "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
      "Accept": "*/*",
      "X-GitHub-Hook-ID": "42",
      "User-Agent": "GitHub-Hookshot/b8c71d8",
      "X-GitHub-Event": "issues",
      "X-GitHub-Hook-Installation-Target-ID": "123",
      "X-GitHub-Hook-Installation-Target-Type": "repository",
      "content-type": "application/json",
      "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
    },
    "payload": {
      "action": "opened",
      "issue": {
        "body": "foo"
      },
      "repository": {
        "id": 123
      }
    }
  },
  "response": {
    "headers": {
      "Content-Type": "text/html;charset=utf-8"
    },
    "payload": "ok"
  }
}

Redeliver a delivery for a repository webhook

适用于 GitHub Apps

Redeliver a webhook delivery for a webhook configured in a repository.

参数

标头
名称, 类型, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner`string必须 The account owner of the repository. The name is not case sensitive.
`repo`string必须 The name of the repository. The name is not case sensitive.
`hook_id`integer必须 The unique identifier of the hook.
`delivery_id`integer必须

HTTP 响应状态代码

状态代码	说明
`202`	Accepted
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

代码示例

post/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveries/DELIVERY_ID/attempts

Accepted

Status: 202