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

Сведения о событиях и полезных данных веб-перехватчика

Вы можете создавать веб-перехватчики, которые подписываются на события, указанные на этой странице. Чтобы ограничить количество HTTP-запросов на сервер, следует подписаться только на определенные события, которые вы планируете обрабатывать. Дополнительные сведения см. в разделе Создание веб-перехватчиков.

Каждое событие веб-перехватчика на этой странице содержит описание свойств веб-перехватчика для этого события. Если событие имеет несколько действий, будут включены свойства, соответствующие каждому действию.

Каждое событие доступно только для определенных типов веб-перехватчиков. Например, веб-перехватчик организации может подписаться на team событие, но веб-перехватчик репозитория не может. Описание каждого события веб-перехватчика содержит сведения о доступности этого события. Дополнительные сведения см. в разделе Типы веб-перехватчиков.

Свойство sender

Большинство полезных данных веб-перехватчика включают sender свойство, определяющее пользователя, активировавшего событие. Иногда GitHub не удается разрешить определенного пользователя, например, когда событие происходит из внутреннего процесса, а не человека, или когда действие активации не имеет связанного пользователя. Для некоторых событий, таких как check_run и check_suite, это включает действия без принудительной отправки или проверки подлинности субъекта API Git.

В таких случаях sender пользователь заполняется ghostучетной записью заполнителя, чья login``ghost``id учетная запись не связана с реальным текущим пользователем. Не предполагайте sender всегда идентифицирует пользователя, вызвавшего событие, и учетную запись ghost пользователя в любой безопасности или бизнес-логике, которая зависит от него.

Крышка полезных данных

Полезные данные ограничены размером 25 МБ. Если событие создает большую полезные данные, GitHub не будет доставлять полезные данные для этого события веб-перехватчика. Это может произойти, например, при событии create в случае одновременной принудительной отправки большого количества ветвей или тегов. Рекомендуем отслеживать размер полезных данных, чтобы обеспечить доставку.

Заголовки доставки

Полезные данные HTTP POST, которые доставляются на настроенную конечную точку URL-адреса вашего веб-перехватчика, будут содержать несколько специальных заголовков:

• X-GitHub-Hook-ID: Уникальный идентификатор вебхука.
• X-GitHub-Event: Название события, которое вызвало доставку.
• X-GitHub-Delivery: глобальный уникальный идентификатор (GUID) для идентификации события.
• X-Hub-Signature: этот заголовок отправляется, если веб-перехватчик настроен с помощью secret. Это хэш-хэш HMAC текста запроса и создается с помощью хэш-функции SHA-1 и secret HMAC key. X-Hub-Signature предоставляется для обеспечения совместимости с существующими интеграциями. Вместо этого рекомендуется использовать более безопасный X-Hub-Signature-256 вариант.
• X-Hub-Signature-256: этот заголовок отправляется, если веб-перехватчик настроен с помощью secret. Это шестнадцатеричный дайджест HMAC текста запроса, который генерируется с использованием хэш-функции SHA-256 и secret в качестве HMAC key. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.
• User-Agent: Этот заголовок всегда будет иметь префикс GitHub-Hookshot/.
• X-GitHub-Hook-Installation-Target-Type: тип ресурса, на котором был создан вебхук.
• X-GitHub-Hook-Installation-Target-ID: Уникальный идентификатор ресурса, по которому был создан вебхук.

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

Пример доставки веб-перехватчика

Полезные данные, доставленные в формате JSON () или в формате URL-адреса (application/json``x-www-form-urlencoded). Ниже приведен пример запроса POST веб-перехватчика, использующего формат JSON.

> POST /payload HTTP/1.1

> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues
> X-GitHub-Hook-ID: 292430182
> X-GitHub-Hook-Installation-Target-ID: 79929171
> X-GitHub-Hook-Installation-Target-Type: repository

> {
>   "action": "opened",
>   "issue": {
>     "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
>     "number": 1347,
>     ...
>   },
>   "repository" : {
>     "id": 1296269,
>     "full_name": "octocat/Hello-World",
>     "owner": {
>       "login": "octocat",
>       "id": 1,
>       ...
>     },
>     ...
>   },
>   "sender": {
>     "login": "octocat",
>     "id": 1,
>     ...
>   }
> }