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

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

В этой статье

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

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

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

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

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

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

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

  1. На GitHubперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  3. На левой боковой панели щелкните Webhooks.

  4. Щелкните Add webhook (Добавить веб-перехватчик).

  5. В поле "URL-адрес полезных данных" введите URL-адрес, в котором вы хотите получать полезные данные.

  6. При необходимости выберите раскрывающееся меню типа контента и выберите формат данных для получения полезных данных веб-перехватчика.

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

  7. При необходимости в разделе "Секрет" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, из GitHubкоторых происходит. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.

  8. В разделе "Какие события вы хотите активировать этот веб-перехватчик?", выберите события веб-перехватчика, которые вы хотите получить. Вы должны подписаться только на нужные события веб-перехватчика.

  9. Если вы выбрали "Разрешить мне выбрать отдельные события", выберите события, которые вы хотите активировать веб-перехватчик.

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

  11. Щелкните Add webhook (Добавить веб-перехватчик).

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

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

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

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

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

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

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

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

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

  1. В правом верхнем углу GitHub Enterprise Serverщелкните рисунок профиля, а затем выберите параметры Enterprise.

  2. В верхней части страницы нажмите «Настройки».

  3. В разделе " Settings", нажмите кнопку "Перехватчики".

  4. Щелкните Add webhook (Добавить веб-перехватчик).

  5. В поле "URL-адрес полезных данных" введите URL-адрес, в котором вы хотите получать полезные данные.

  6. При необходимости выберите раскрывающееся меню типа контента и выберите формат данных для получения полезных данных веб-перехватчика.

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

  7. При необходимости в разделе "Секрет" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, из GitHubкоторых происходит. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.

  8. При необходимости, если URL-адрес полезных данных — HTTPS, и вы не хотите GitHub Enterprise Server проверять SSL-сертификаты при доставке полезных данных в разделе "Проверка SSL", нажмите кнопку "Отключить". Ознакомьтесь с информацией о проверке SSL, а затем нажмите кнопку "Отключить", я понимаю, что мои веб-перехватчики могут быть небезопасны.

    Предупреждение

    Проверка SSL помогает обеспечить безопасное доставку полезных данных перехватчика. Не рекомендуется отключать проверку SSL.

  9. В разделе "Какие события вы хотите активировать этот веб-перехватчик?", выберите типы веб-перехватчиков, которые вы хотите получить. Вы должны подписаться только на нужные события веб-перехватчика.

  10. Если вы выбрали "Разрешить мне выбрать отдельные события", выберите события, которые будут активировать веб-перехватчик.

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

  12. Щелкните Add webhook (Добавить веб-перехватчик).

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

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

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

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

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

  1. В правом верхнем углу любой страницы на GitHubщелкните рисунок профиля.

  2. Перейдите к настройкам учетной записи.

    • Для приложения, принадлежащих личная учетная запись, нажмите кнопку "Параметры".
    • Для приложения, принадлежащих организации:
      1. Щелкните Your organizations (Ваши организации).
      2. Справа от организации нажмите кнопку "Параметры".
    • Для приложения, принадлежающего предприятия:
      1. Щелкните "Параметры предприятия".

  3. Перейдите к параметрам GitHub App .

    • Для приложения, принадлежащих личная учетная запись или организации:
      1. На левой боковой панели щелкните Параметры разработчика, а затем выберите GitHub Apps.
    • Для приложения, принадлежаемого предприятием:
      1. На левой боковой панели щелкните "Параметры **", а затем щелкните **GitHub Apps.

  4. Рядом с GitHub App нужным веб-перехватчиком нажмите кнопку "Изменить".

  5. В разделе "Веб-перехватчик" выберите "Активный".

  6. В поле "URL-адрес веб-перехватчика" введите URL-адрес, в котором вы хотите получать полезные данные.

  7. При необходимости в разделе "Секрет веб-перехватчика" введите строку для использования в качестве secret ключа. Следует выбрать случайную строку текста с высокой энтропией. Секрет веб-перехватчика можно использовать, чтобы ограничить входящие запросы только теми, из GitHubкоторых происходит. Дополнительные сведения см. в разделе Проверка доставки веб-перехватчика.

  8. Нажмите кнопку Сохранить изменения.

  9. На боковой панели щелкните "Разрешения" и "События".

  10. Определенные события веб-перехватчика, которые можно выбрать для регистрации GitHub App, определяются типом разрешений, выбранных для вашего приложения. Сначала необходимо выбрать разрешения, которые требуется приложению, а затем подписаться на события веб-перехватчика, связанные с этим набором разрешений.

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

  11. В разделе "Подписка на события" выберите события веб-перехватчика, которые вы хотите GitHub App получить.

  12. Нажмите кнопку Сохранить изменения.

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

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