Примечание. Веб-перехватчики GitHub в настоящее время не поддерживают протокол IPv6, но будут доступны в будущем. Конечная /meta точка REST API возвращает диапазоны IPv6, чтобы обеспечить этот переход.
Веб-перехватчики позволяют создавать или настраивать интеграции, такие как GitHub Apps или OAuth Apps, которые подписываются на определенные события на сайте GitHub.com. Когда запускается одно из этих событий, мы отправляем полезные данные HTTP POST веб-перехватчику, используя настроенный URL-адрес. Веб-перехватчики можно использовать для обновления внешнего средства отслеживания проблем, активации сборок CI, обновления зеркала резервного копирования или даже развертывания на рабочем сервере. Вы ограничены только вашим воображением.
Веб-перехватчики можно установить в GitHub Enterprise, организации, в определенном репозитории или в GitHub App. После установки веб-перехватчик будет отправляться каждый раз, когда возникнет одно или несколько событий подписки.
Можно создать до 250 веб-перехватчиков для каждого события в каждом экземпляре целевого объекта установки (GitHub Enterprise Server, для конкретной организации или конкретного репозитория).
События
При настройке веб-перехватчика можно выбрать, какие события будут отправлять полезные данные. Чтобы ограничить количество HTTP-запросов к серверу, следует подписаться только на определенные события, которые вы планируете обрабатывать. По умолчанию веб-перехватчики, установленные в GitHub Enterprise, organization, или repository подписаны только на событие push-уведомлений. По умолчанию веб-перехватчики в GitHub Apps не подписываются на какие-либо события. Вы можете изменить события, на которые подписан веб-перехватчик, в любое время.
Каждое событие соответствует определенному набору действий, которые могут произойти в вашей организации и (или) репозитории. Например, если подписаться на событие issues, вы будете получать детализированные полезные данные при каждом открытии, закрытии, маркировке проблемы и т. д.
Полный список доступных событий веб-перехватчика и их полезных данных см. в разделе События и полезные данные веб-перехватчика.
Событие проверки связи
При создании нового веб-перехватчика мы отправим вам простое событие ping, подтверждающее правильность настройки веб-перехватчика. Это событие не сохраняется и не может быть извлечено через конечную точку API событий.
Дополнительные сведения о полезных данных веб-перехватчика события ping см. в этом событии ping.