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

О создании веб-перехватчиков

Вы можете создавать веб-перехватчики для подписки на определенные события на GitHub , которые происходят в репозитории, organization, GitHub Marketplace account, GitHub Sponsors account, или GitHub App.

Дополнительные сведения о различных типах веб-перехватчиков см. в разделе Типы веб-перехватчиков.

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

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

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

Для создания веб-перехватчика репозитория можно использовать веб-интерфейс GitHub или REST API. Дополнительные сведения об использовании REST API для создания веб-перехватчика репозитория см. в разделе Конечные точки REST API для веб-перехватчиков репозитория.

На GitHubперейдите на главную страницу репозитория.
Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".
На левой боковой панели щелкните Webhooks.
Щелкните Add webhook (Добавить веб-перехватчик).
В поле "URL-адрес полезных данных" введите URL-адрес, в котором вы хотите получать полезные данные.
При необходимости выберите раскрывающееся меню типа контента и выберите формат данных для получения полезных данных веб-перехватчика.
- application/json доставляет полезные данные JSON непосредственно в тексте POST запроса.
- application/x-www-form-urlencoded отправляет полезные данные JSON в качестве параметра payloadформы.
При необходимости в разделе "Секрет" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, которые исходят из GitHub. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.
В разделе "Какие события вы хотите активировать этот веб-перехватчик?", выберите события веб-перехватчика, которые вы хотите получить. Вы должны подписаться только на нужные события веб-перехватчика.
Если вы выбрали "Разрешить мне выбрать отдельные события", выберите события, которые вы хотите активировать веб-перехватчик.
Чтобы сделать веб-перехватчик активным сразу после добавления конфигурации, нажмите кнопку "Активный".
Щелкните Add webhook (Добавить веб-перехватчик).

После создания нового веб-перехватчика GitHub отправит вам простое ping событие, чтобы сообщить, что вы правильно настроили веб-перехватчик. Дополнительные сведения см. в разделе События и полезные данные веб-перехватчика.

Создание веб-перехватчика организации

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

Для создания веб-перехватчика организации можно использовать веб-интерфейс GitHub или REST API. Дополнительные сведения об использовании REST API для создания веб-перехватчика организации см. в разделе Конечные точки REST API для веб-перехватчиков организации.

В правом верхнем углу любой страницы на GitHubщелкните рисунок профиля.
Щелкните Your organizations (Ваши организации).
Справа от организации нажмите кнопку "Параметры".
На левой боковой панели щелкните Webhooks.
Щелкните Add webhook (Добавить веб-перехватчик).
В поле "URL-адрес полезных данных" введите URL-адрес, в котором вы хотите получать полезные данные.
При необходимости выберите раскрывающееся меню типа контента и выберите формат данных для получения полезных данных веб-перехватчика.
- application/json доставляет полезные данные JSON непосредственно в тексте POST запроса.
- application/x-www-form-urlencoded отправляет полезные данные JSON в качестве параметра payloadформы.
При необходимости в разделе "Секрет" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, которые исходят из GitHub. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.
В разделе "Какие события вы хотите активировать этот веб-перехватчик?", выберите типы веб-перехватчиков, которые вы хотите получить. Вы должны подписаться только на нужные события веб-перехватчика.
Если вы выбрали "Разрешить мне выбрать отдельные события", выберите события, которые будут активировать веб-перехватчик.
Чтобы сделать веб-перехватчик активным сразу после добавления конфигурации, нажмите кнопку "Активный".
Щелкните Add webhook (Добавить веб-перехватчик).

Создание веб-перехватчика GitHub Marketplace

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

Перейдите на страницу описания GitHub Marketplace.
Рядом с описанием GitHub Marketplace для просмотра доставки веб-перехватчика нажмите кнопку " Управление списком".
На боковой панели щелкните веб-перехватчик.
В поле "URL-адрес полезных данных" введите URL-адрес, в котором вы хотите получать полезные данные.
При необходимости выберите раскрывающееся меню типа контента и выберите формат данных для получения полезных данных веб-перехватчика.
- application/json доставляет полезные данные JSON непосредственно в тексте POST запроса.
- application/x-www-form-urlencoded отправляет полезные данные JSON в качестве параметра payloadформы.
При необходимости в разделе "Секрет" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, которые исходят из GitHub. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.
Чтобы сделать веб-перехватчик активным сразу после добавления конфигурации, нажмите кнопку "Активный".
Нажмите Создать веб-перехватчик.

Создание веб-перехватчика GitHub Sponsors

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

В правом верхнем углу любой страницы щелкните рисунок профиля, а затем выберите "Спонсоры".
Рядом с учетной записью, для которой вы хотите создать веб-перехватчик, нажмите кнопку "Панель мониторинга".
На левой боковой панели нажмите Веб-перехватчики.
Щелкните Add webhook (Добавить веб-перехватчик).
В поле "URL-адрес полезных данных" введите URL-адрес, в котором вы хотите получать полезные данные.
При необходимости выберите раскрывающееся меню типа контента и выберите формат данных для получения полезных данных веб-перехватчика.
- application/json доставляет полезные данные JSON непосредственно в тексте POST запроса.
- application/x-www-form-urlencoded отправляет полезные данные JSON в качестве параметра payloadформы.
При необходимости в разделе "Секрет" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, которые исходят из GitHub. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.
Чтобы сделать веб-перехватчик активным сразу после добавления конфигурации, нажмите кнопку "Активный".
Нажмите Создать веб-перехватчик.

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

Владелец GitHub App может подписать приложение на события веб-перехватчика для получения уведомлений при каждом возникновении определенных событий. Если владелец приложения назначил всех диспетчеров приложений для GitHub App, руководители приложений также могут подписать приложение на события веб-перехватчика. Дополнительные сведения см. в разделе Использование вебхуков с приложениями GitHub.

Каждый variables.product.prodname_github_app %} данных имеет один веб-перехватчик. При регистрации GitHub Appможно настроить веб-перехватчик или изменить конфигурацию веб-перехватчика для существующей регистрации GitHub App.

Дополнительные сведения о настройке веб-перехватчика при регистрации GitHub Appсм. в разделе Регистрация приложения GitHub.

Чтобы настроить веб-перехватчик для существующей регистрации GitHub App:

В правом верхнем углу любой страницы на GitHubщелкните рисунок профиля.
Перейдите к настройкам учетной записи.
- Для приложения, принадлежащих личная учетная запись, нажмите кнопку "Параметры".
- Для приложения, принадлежащих организации:
  1. Щелкните Your organizations (Ваши организации).
  2. Справа от организации нажмите кнопку "Параметры".
На левой боковой панели щелкните Параметры разработчика.
На левой боковой панели щелкните GitHub Apps.
Рядом с GitHub App для настройки веб-перехватчика нажмите кнопку "Изменить".
В разделе "Веб-перехватчик" выберите "Активный".
В поле "URL-адрес веб-перехватчика" введите URL-адрес, в котором вы хотите получать полезные данные.
При необходимости в разделе "Секрет веб-перехватчика" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, которые исходят из GitHub. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.
Нажмите кнопку Сохранить изменения.
На боковой панели щелкните "Разрешения" и "События".
Определенные события веб-перехватчика, которые можно выбрать для регистрации GitHub App, определяются типом разрешений, выбранных для вашего приложения. Сначала необходимо выбрать разрешения, которые требуется приложению, а затем подписаться на события веб-перехватчика, связанные с этим набором разрешений.

В разделах "Разрешения репозитория", "Разрешения организации" и "Разрешения учетной записи" выберите разрешения, необходимые для событий, на которые будет подписано ваше приложение. Дополнительные сведения см. в разделе Выбор разрешений для приложения GitHub. Дополнительные сведения о том, что следует учитывать при изменении разрешений, см. в разделе "Изменение регистрации GitHub App".
В разделе "Подписка на события" выберите события веб-перехватчика, которые вы хотите получать GitHub App.
Нажмите кнопку Сохранить изменения.

Rest API также можно использовать для создания веб-перехватчика для GitHub App. Дополнительные сведения см. в разделе Конечные точки REST API для GitHub App веб-перехватчиков.

Дополнительные материалы

        [AUTOTITLE](/webhooks/about-webhooks)

        [AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries)

В этой статье