Примечание: Эта статья относится только к публикации GitHub Apps в GitHub Marketplace. Дополнительные сведения о публикации GitHub Actions в GitHub Marketplace см. в разделе Публикация действий в GitHub Marketplace.
Веб-перехватчик событий GitHub Marketplace можно настроить только на странице профиля приложения в GitHub Marketplace. Все остальные события можно настроить на странице параметров разработчика приложения. Если вы еще не создали описание GitHub Marketplace, прочитайте статью Создание черновика профиля для приложения, чтобы узнать, как это сделать.
Создание объекта Webhook
Чтобы создать веб-перехватчик для профиля в GitHub Marketplace, щелкните Веб-перехватчик на левой боковой панели страницы профиля в GitHub Marketplace. Вы увидите следующие параметры конфигурации веб-перехватчика, необходимые для его настройки:
URL-адрес полезных данных
URL-адрес полезных данных — это URL-адрес сервера, который будет получать запросы POST
веб-перехватчика.
Тип содержимого
Веб-перехватчики могут доставляться с помощью разных типов содержимого:
- Тип содержимого
application/json
предоставляет полезные данные JSON непосредственно в виде текста запросаPOST
. - Тип содержимого
application/x-www-form-urlencoded
отправляет полезные данные JSON как параметр формы с именемpayload
.
Выбирайте ту, что наилучшим образом подходит под ваши нужды. GitHub рекомендует использовать тип содержимого application/json
.
Секрет
Настройка секрета веб-перехватчика позволяет гарантировать, что запросы POST
, отправленные на URL-адрес полезных данных, поступают из GitHub Enterprise Cloud. При установке секрета вы будете получать заголовки X-Hub-Signature
и X-Hub-Signature-256
в запросе POST
веб-перехватчика. Дополнительные сведения об использовании секрета с заголовком подписи для защиты полезных данных веб-перехватчика см. в разделе Защита веб-перехватчиков.
Активен
По умолчанию доставки веб-перехватчика имеют статус "Активно". Вы можете отключить доставку полезных данных веб-перехватчика, отменив выбор статуса "Активно". Если вы отключили доставку данных веб-перехватчика, перед отправкой приложения на проверку необходимо выбрать статус "Активно".
Просмотр доставленных данных веб-перехватчика
После настройки веб-перехватчика GitHub Marketplace вы сможете проверить полезные данные запроса POST
на странице Веб-перехватчик в профиле приложения в GitHub Marketplace. GitHub не выполняет повторную отправку в случае сбоя доставки. Убедитесь, что приложение может принимать все полезные данные веб-перехватчика, отправленные GitHub.