Настройка веб-перехватчика для уведомления об изменениях плана

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

В этой статье

Note

Эта статья относится только к публикации приложений в GitHub Marketplace. Дополнительные сведения о публикации GitHub Actions в GitHub Marketplaceсм. в разделе "Публикация действий в GitHub Marketplace".

Веб-перехватчик событий GitHub Marketplace можно настроить только на странице профиля приложения в GitHub Marketplace. Все остальные события можно настроить на странице параметров разработчика приложения. Если вы не создали описание GitHub Marketplace, ознакомьтесь со статьей AUTOTITLE, чтобы узнать, как это сделать.

Создание объекта Webhook

Чтобы создать веб-перехватчик для профиля в GitHub Marketplace, щелкните Веб-перехватчик на левой боковой панели страницы профиля в GitHub Marketplace. Вы увидите следующие параметры конфигурации веб-перехватчика, необходимые для его настройки:

URL-адрес полезных данных

URL-адрес полезных данных — это URL-адрес сервера, который будет получать запросы POST веб-перехватчика.

Content type

Веб-перехватчики могут доставляться с помощью разных типов содержимого:

  • Тип содержимого application/json предоставляет полезные данные JSON непосредственно в виде текста запроса POST.
  • Тип содержимого application/x-www-form-urlencoded отправляет полезные данные JSON как параметр формы с именем payload.

Выберите тот, который лучше всего соответствует вашим потребностям. GitHub рекомендует использовать тип содержимого application/json.

Секретный

Настройка секрета веб-перехватчика позволяет гарантировать, что запросы POST, отправленные на URL-адрес полезных данных, поступают из GitHub. При установке секрета вы получите X-Hub-Signature заголовки и X-Hub-Signature-256 заголовки в запросе веб-перехватчика POST . Дополнительные сведения об использовании секрета с заголовком подписи для защиты полезных данных веб-перехватчика см. в разделе "Проверка доставки веб-перехватчика".

Активно

По умолчанию доставки веб-перехватчика имеют статус "Активно". Вы можете отключить доставку полезных данных веб-перехватчика, отменив выбор статуса "Активно". Если вы отключили доставку данных веб-перехватчика, перед отправкой приложения на проверку необходимо выбрать статус "Активно".

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

После настройки веб-перехватчика GitHub Marketplace вы сможете проверить полезные данные запроса POST на странице Веб-перехватчик в профиле приложения в GitHub Marketplace. GitHub не выполняет повторную отправку в случае сбоя доставки. Убедитесь, что приложение может принимать все полезные данные веб-перехватчика, отправленные GitHub.

Снимок экрана: последние поставки веб-перехватчика для списка GitHub Marketplace .