存储库 Webhook

使用 REST API 管理存储库 Webhook。

List repository webhooks

Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.

“List repository webhooks”的参数

标头
名称, 类型, 说明
`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.
查询参数
名称, 类型, 说明
`per_page`integer The number of results per page (max 100). 默认: `30`
`page`integer Page number of the results to fetch. 默认: `1`

“List repository webhooks”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found

“List repository webhooks”的示例代码

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks

Response

Status: 200

[
  {
    "type": "Repository",
    "id": 12345678,
    "name": "web",
    "active": true,
    "events": [
      "push",
      "pull_request"
    ],
    "config": {
      "content_type": "json",
      "insecure_ssl": "0",
      "url": "https://example.com/webhook"
    },
    "updated_at": "2019-06-03T00:57:16Z",
    "created_at": "2019-06-03T00:57:16Z",
    "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
    "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
    "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
    "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
    "last_response": {
      "code": null,
      "status": "unused",
      "message": null
    }
  }
]

Create a repository webhook

适用于 GitHub Apps

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

“Create a repository webhook”的参数

标头

名称, 类型, 说明

acceptstring

Setting to application/vnd.github+json is recommended.

路径参数

名称, 类型, 说明

ownerstring必选

The account owner of the repository. The name is not case sensitive.

repostring必选

The name of the repository. The name is not case sensitive.

正文参数

名称, 类型, 说明

namestring

Use web to create a webhook. Default: web. This parameter only accepts the value web.

configobject

Key/value pairs to provide settings for this webhook. These are defined below.

Properties of config

名称, 类型, 说明
`url`string The URL to which the payloads will be delivered.
`content_type`string The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
`secret`string If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for delivery signature headers.
`insecure_ssl`string or number Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.
`token`string
`digest`string

eventsarray of strings

Determines what events the hook is triggered for.

默认: ["push"]

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

默认: true

“Create a repository webhook”的 HTTP 响应状态代码

状态代码	说明
`201`	Created
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Create a repository webhook”的示例代码

post/repos/{owner}/{repo}/hooks

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks \
  -d '{"name":"web","active":true,"events":["push","pull_request"],"config":{"url":"https://example.com/webhook","content_type":"json","insecure_ssl":"0"}}'

Response

Status: 201

{
  "type": "Repository",
  "id": 12345678,
  "name": "web",
  "active": true,
  "events": [
    "push",
    "pull_request"
  ],
  "config": {
    "content_type": "json",
    "insecure_ssl": "0",
    "url": "https://example.com/webhook"
  },
  "updated_at": "2019-06-03T00:57:16Z",
  "created_at": "2019-06-03T00:57:16Z",
  "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
  "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
  "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
  "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
  "last_response": {
    "code": null,
    "status": "unused",
    "message": null
  }
}

Get a repository webhook

适用于 GitHub Apps

Returns a webhook configured in a repository. To get only the webhook config properties, see "Get a webhook configuration for a repository."

“Get a repository webhook”的参数

标头
名称, 类型, 说明
`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.

“Get a repository webhook”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found

“Get a repository webhook”的示例代码

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks/HOOK_ID

Response

Status: 200

{
  "type": "Repository",
  "id": 12345678,
  "name": "web",
  "active": true,
  "events": [
    "push",
    "pull_request"
  ],
  "config": {
    "content_type": "json",
    "insecure_ssl": "0",
    "url": "https://example.com/webhook"
  },
  "updated_at": "2019-06-03T00:57:16Z",
  "created_at": "2019-06-03T00:57:16Z",
  "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
  "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
  "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
  "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
  "last_response": {
    "code": null,
    "status": "unused",
    "message": null
  }
}

Update a repository webhook

适用于 GitHub Apps

Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for a repository."

“Update a repository webhook”的参数

标头

名称, 类型, 说明

acceptstring

Setting to application/vnd.github+json is recommended.

路径参数

名称, 类型, 说明

ownerstring必选

The account owner of the repository. The name is not case sensitive.

repostring必选

The name of the repository. The name is not case sensitive.

hook_idinteger必选

The unique identifier of the hook.

正文参数

名称, 类型, 说明

configobject

Key/value pairs to provide settings for this webhook. These are defined below.

Properties of config

名称, 类型, 说明
`url`string必选 The URL to which the payloads will be delivered.
`content_type`string The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
`secret`string If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for delivery signature headers.
`insecure_ssl`string or number Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.
`address`string
`room`string

eventsarray of strings

Determines what events the hook is triggered for. This replaces the entire array of events.

默认: ["push"]

add_eventsarray of strings

Determines a list of events to be added to the list of events that the Hook triggers for.

remove_eventsarray of strings

Determines a list of events to be removed from the list of events that the Hook triggers for.

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

默认: true

“Update a repository webhook”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Update a repository webhook”的示例代码

patch/repos/{owner}/{repo}/hooks/{hook_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks/HOOK_ID \
  -d '{"active":true,"add_events":["pull_request"]}'

Response

Status: 200

{
  "type": "Repository",
  "id": 12345678,
  "name": "web",
  "active": true,
  "events": [
    "push",
    "pull_request"
  ],
  "config": {
    "content_type": "json",
    "insecure_ssl": "0",
    "url": "https://example.com/webhook"
  },
  "updated_at": "2019-06-03T00:57:16Z",
  "created_at": "2019-06-03T00:57:16Z",
  "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
  "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
  "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
  "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
  "last_response": {
    "code": null,
    "status": "unused",
    "message": null
  }
}

Delete a repository webhook

适用于 GitHub Apps

“Delete a repository webhook”的参数

标头
名称, 类型, 说明
`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.

“Delete a repository webhook”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found

“Delete a repository webhook”的示例代码

delete/repos/{owner}/{repo}/hooks/{hook_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks/HOOK_ID

Response

Status: 204

Ping a repository webhook

适用于 GitHub Apps

This will trigger a ping event to be sent to the hook.

“Ping a repository webhook”的参数

标头
名称, 类型, 说明
`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.

“Ping a repository webhook”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found

“Ping a repository webhook”的示例代码

post/repos/{owner}/{repo}/hooks/{hook_id}/pings

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks/HOOK_ID/pings

Response

Status: 204

Test the push repository webhook

适用于 GitHub Apps

This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

Note: Previously /repos/:owner/:repo/hooks/:hook_id/test

“Test the push repository webhook”的参数

标头
名称, 类型, 说明
`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.

“Test the push repository webhook”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found

“Test the push repository webhook”的示例代码

post/repos/{owner}/{repo}/hooks/{hook_id}/tests

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/hooks/HOOK_ID/tests

Response

Status: 204