Веб-перехватчики репозитория

Используйте REST API для управления веб-перехватчиками репозитория.

List repository webhooks

Работа с GitHub Apps

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`

Коды состояния HTTP-ответа для "List repository webhooks"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/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"

Заголовки

Имя, Тип, Описание

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.

Параметры запроса

Имя, Тип, Описание

name string

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

config object

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

events array of strings

Determines what events the hook is triggered for.

Значение по умолчанию: ["push"]

active boolean

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

Значение по умолчанию: true

Коды состояния HTTP-ответа для "Create a repository webhook"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/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.

Коды состояния HTTP-ответа для "Get a repository webhook"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/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"

Заголовки

Имя, Тип, Описание

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.

Параметры запроса

Имя, Тип, Описание

config object

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

events array of strings

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

Значение по умолчанию: ["push"]

add_events array of strings

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

remove_events array of strings

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

active boolean

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

Значение по умолчанию: true

Коды состояния HTTP-ответа для "Update a repository webhook"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/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.

Коды состояния HTTP-ответа для "Delete a repository webhook"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/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.

Коды состояния HTTP-ответа для "Ping a repository webhook"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/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.

Коды состояния HTTP-ответа для "Test the push repository webhook"

Код состояния	Описание
`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>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/tests

Response

Status: 204