참고: GitHub 웹후크는 현재 IPv6을 지원하지 않지만 향후 지원될 예정입니다. REST API 엔드포인트는 /meta IPv6 범위를 반환하여 해당 전환을 사용하도록 설정합니다.
웹후크를 사용하면 GitHub.com에서 특정 이벤트를 구독하는 GitHub Apps 또는 OAuth Apps와 같은 통합을 빌드하거나 설정할 수 있습니다. 이러한 이벤트 중 하나가 트리거되면 웹후크에 구성된 URL로 HTTP POST 페이로드를 보냅니다. 웹후크는 외부 이슈 추적기를 업데이트하거나, CI 빌드를 트리거하거나, 백업 미러를 업데이트하거나, 프로덕션 서버에 배포하는 데 사용할 수 있습니다. 유일한 걸림돌은 사용자의 상상력입니다.
웹후크는 GitHub Enterprise, 조직, 특정 리포지토리 또는 GitHub App에 설치할 수 있습니다. 설치되면 웹후크는 구독된 이벤트가 하나 이상 발생될 때마다 전송됩니다.
각 설치 대상(GitHub Enterprise Server 인스턴스, 특정 조직 또는 특정 리포지토리).
이벤트
웹후크를 구성할 때 페이로드를 보낼 이벤트를 선택할 수 있습니다. 서버에 대한 HTTP 요청 수를 제한하려면 처리하려는 특정 이벤트만 구독해야 합니다. 기본적으로 GitHub Enterprise, organization, 또는 [리포지토리][리포지토리][리포지토리]에 설치된 웹후크는 푸시 이벤트에만 구독됩니다. 기본적으로 GitHub Apps의 웹후크는 이벤트를 구독하지 않습니다. 언제든지 웹후크가 구독하는 이벤트를 변경할 수 있습니다.
각 이벤트는 조직 및/또는 리포지토리에 발생할 수 있는 특정 작업 집합에 해당합니다. 예를 들어 issues 이벤트를 구독하는 경우 이슈가 열리고, 닫혀 있고, 레이블이 지정될 때마다 자세한 페이로드를 받게 됩니다.
사용 가능한 웹후크 이벤트 및 해당 페이로드의 전체 목록은 "웹후크 이벤트 및 페이로드"을 참조하세요.
Ping 이벤트
새 웹후크를 만들 때 웹후크를 올바르게 설정했음을 알리는 간단한 ping 이벤트를 보내드립니다. 이 이벤트는 저장되지 않으므로 이벤트 API 엔드포인트를 통해 조회할 수 없습니다.
ping 이벤트 웹후크 페이로드에 대한 자세한 내용은 ping 이벤트를 참조하세요.