Конечные точки REST API для GitHub App веб-перехватчиков

Сведения о веб-перехватчиках для GitHub Apps

Веб-перехватчик GitHub Appпозволяет серверу получать полезные данные HTTP POST при каждом возникновении определенных событий для GitHub App. Дополнительные сведения см. в разделе [AUTOTITLE и Документация по веб-перехватчикам](/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).

Get a webhook configuration for an app

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

You must use a JWT to access this endpoint.

Подробные маркеры доступа для "Get a webhook configuration for an app

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Коды состояния http-ответа для "Get a webhook configuration for an app"

Код состояния	Описание
`200`	OK

Примеры кода для "Get a webhook configuration for an app"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/app/hook/config

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/app/hook/config

Response

Status: 200

{
  "content_type": "json",
  "insecure_ssl": "0",
  "secret": "********",
  "url": "https://example.com/webhook"
}

Update a webhook configuration for an app

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

You must use a JWT to access this endpoint.

Подробные маркеры доступа для "Update a webhook configuration for an app

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Update a webhook configuration for an app"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры запроса
Имя., Тип, Description
`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.

Коды состояния http-ответа для "Update a webhook configuration for an app"

Код состояния	Описание
`200`	OK

Примеры кода для "Update a webhook configuration for an app"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

patch/app/hook/config

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/app/hook/config \
  -d '{"content_type":"json","insecure_ssl":"0","secret":"********","url":"https://example.com/webhook"}'

Response

Status: 200

{
  "content_type": "json",
  "insecure_ssl": "0",
  "secret": "********",
  "url": "https://example.com/webhook"
}

List deliveries for an app webhook

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

Подробные маркеры доступа для "List deliveries for an app webhook

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "List deliveries for an app webhook"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры запроса
Имя., Тип, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `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.

Коды состояния http-ответа для "List deliveries for an app webhook"

Код состояния	Описание
`200`	OK
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "List deliveries for an app webhook"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/app/hook/deliveries

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/app/hook/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,
    "throttled_at": "2019-06-03T00:57:16Z"
  },
  {
    "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,
    "throttled_at": null
  }
]

Get a delivery for an app webhook

Returns a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

Подробные маркеры доступа для "Get a delivery for an app webhook

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Get a delivery for an app webhook"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`delivery_id` integer Обязательное поле

Коды состояния http-ответа для "Get a delivery for an app webhook"

Код состояния	Описание
`200`	OK
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Get a delivery for an app webhook"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/app/hook/deliveries/{delivery_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/app/hook/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",
  "throttled_at": "2019-06-03T00:57:16Z",
  "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"
  }
}

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`delivery_id` integer Обязательное поле

Коды состояния http-ответа для "Redeliver a delivery for an app webhook"

Код состояния	Описание
`202`	Accepted
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Redeliver a delivery for an app webhook"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

post/app/hook/deliveries/{delivery_id}/attempts

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/app/hook/deliveries/DELIVERY_ID/attempts

Accepted

Status: 202

Конечные точки REST API для GitHub App веб-перехватчиков

Сведения о веб-перехватчиках для GitHub Apps

Get a webhook configuration for an app

Подробные маркеры доступа для "Get a webhook configuration for an app

Коды состояния http-ответа для "Get a webhook configuration for an app"

Примеры кода для "Get a webhook configuration for an app"

Пример запроса

Response

Update a webhook configuration for an app

Подробные маркеры доступа для "Update a webhook configuration for an app

Параметры для "Update a webhook configuration for an app"

Коды состояния http-ответа для "Update a webhook configuration for an app"

Примеры кода для "Update a webhook configuration for an app"

Пример запроса

Response

List deliveries for an app webhook

Подробные маркеры доступа для "List deliveries for an app webhook

Параметры для "List deliveries for an app webhook"

Коды состояния http-ответа для "List deliveries for an app webhook"

Примеры кода для "List deliveries for an app webhook"

Пример запроса

Response

Get a delivery for an app webhook

Подробные маркеры доступа для "Get a delivery for an app webhook

Параметры для "Get a delivery for an app webhook"

Коды состояния http-ответа для "Get a delivery for an app webhook"

Примеры кода для "Get a delivery for an app webhook"

Пример запроса

Response

Redeliver a delivery for an app webhook

Подробные маркеры доступа для "Redeliver a delivery for an app webhook

Параметры для "Redeliver a delivery for an app webhook"

Коды состояния http-ответа для "Redeliver a delivery for an app webhook"

Примеры кода для "Redeliver a delivery for an app webhook"

Пример запроса

Accepted