웹후크 만들기 알아보기
웹후크를 만들어 리포지토리, 조직, GitHub Enterprise, 또는 GitHub App에서 발생하는 특정 이벤트를 GitHub에서 구독할 수 있습니다.
다양한 유형의 웹후크에 대한 자세한 내용은 "웹후크 유형"을(를) 참조하세요.
웹후크 이벤트의 전체 목록은 "웹후크 이벤트 및 페이로드"을(를) 참조하세요.
리포지토리 웹후크 만들기
특정 리포지토리에서 발생하는 이벤트를 구독하는 웹후크를 만들 수 있습니다. 리포지토리에서 웹후크를 만들려면 해당 리포지토리의 소유자이거나 리포지토리의 관리자 액세스 권한이 있어야 합니다.
GitHub 웹 인터페이스 또는 REST API를 사용하여 리포지토리 웹후크를 만들 수 있습니다. REST API를 사용하여 리포지토리 웹후크를 만드는 방법에 대한 자세한 내용은 "리포지토리 웹후크에 대한 REST API 엔드포인트"을(를) 참조하세요.
-
GitHub Enterprise Server 인스턴스에서 리포지토리의 기본 페이지로 이동합니다.
-
리포지토리 이름 아래에서 Settings(설정)를 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.
-
왼쪽 사이드바에서 웹후크를 클릭합니다.
-
웹후크 추가를 클릭합니다.
-
"페이로드 URL"에서 페이로드를 수신하려는 URL을 입력합니다.
-
필요에 따라 콘텐츠 형식 드롭다운 메뉴를 선택하고 웹후크 페이로드를 수신할 데이터 서식을 클릭합니다.
- application/json은
POST
요청의 본문으로 직접 JSON 페이로드를 전달합니다. - application/x-www-form-urlencoded는
payload
(이)라는 양식 매개 변수로 JSON 페이로드를 전송합니다.
- application/json은
-
필요에 따라 "비밀"에서
secret
키로 사용할 문자열을 입력합니다. 엔트로피가 높은 임의의 텍스트 문자열을 선택해야 합니다. 웹후크 비밀을 사용하여 들어오는 요청을 GitHub에서 시작된 요청으로만 제한할 수 있습니다. 자세한 내용은 "웹후크 제공 유효성 검사하기"을(를) 참조하세요. -
"이 웹후크를 트리거할 이벤트는 무엇인가요?"에서 수신하려는 웹후크 이벤트를 선택합니다. 필요한 웹후크 이벤트만 구독해야 합니다.
-
이벤트를 각각 선택하겠습니다를 선택했다면 웹후크를 트리거하고자 하는 이벤트를 선택합니다.
-
구성을 추가한 다음 웹후크를 즉시 활성화하려면 활성화를 선택합니다.
-
웹후크 추가를 클릭합니다.
새 웹후크를 만들고 나면 GitHub에서 웹후크가 올바르게 설정되었음을 알리는 간단한 ping
이벤트를 보냅니다. 자세한 내용은 "웹후크 이벤트 및 페이로드"을(를) 참조하세요.
조직 웹후크 만들기
특정 조직에서 발생하는 이벤트를 구독하는 웹후크를 만들 수 있습니다. 조직에서 웹후크를 만들려면 해당 조직의 소유자여야야 합니다.
GitHub 웹 인터페이스 또는 REST API를 사용하여 조직 웹후크를 만들 수 있습니다. REST API를 사용하여 조직 웹후크를 만드는 방법에 대한 자세한 내용은 "조직 웹후크에 대한 REST API 엔드포인트"을(를) 참조하세요.
- GitHub Enterprise Server 인스턴스에 있는 임의의 페이지의 오른쪽 상단에서 프로필 사진을 클릭합니다.
- 사용자의 조직을 클릭합니다.
- 그런 다음, 조직 오른쪽에 있는 설정을 클릭합니다.
- 왼쪽 사이드바에서 웹후크를 클릭합니다.
- 웹후크 추가를 클릭합니다.
- "페이로드 URL"에서 페이로드를 수신하려는 URL을 입력합니다.
- 필요에 따라 콘텐츠 형식 드롭다운 메뉴를 선택하고 웹후크 페이로드를 수신할 데이터 서식을 클릭합니다.
- application/json은
POST
요청의 본문으로 직접 JSON 페이로드를 전달합니다. - application/x-www-form-urlencoded는
payload
(이)라는 양식 매개 변수로 JSON 페이로드를 전송합니다.
- application/json은
- 필요에 따라 "비밀"에서
secret
키로 사용할 문자열을 입력합니다. 엔트로피가 높은 임의의 텍스트 문자열을 선택해야 합니다. 웹후크 비밀을 사용하여 들어오는 요청을 GitHub에서 시작된 요청으로만 제한할 수 있습니다. 자세한 내용은 "웹후크 제공 유효성 검사하기"을(를) 참조하세요. - "이 웹후크를 트리거할 이벤트는 무엇인가요?"에서 수신하려는 웹후크 유형을 선택합니다. 필요한 웹후크 이벤트만 구독해야 합니다.
- 이벤트를 각각 선택하겠습니다를 선택했다면 웹후크를 트리거할 이벤트를 선택합니다.
- 구성을 추가한 다음 웹후크를 즉시 활성화하려면 활성화를 선택합니다.
- 웹후크 추가를 클릭합니다.
새 웹후크를 만들고 나면 GitHub에서 웹후크가 올바르게 설정되었음을 알리는 간단한 ping
이벤트를 보냅니다. 자세한 내용은 "웹후크 이벤트 및 페이로드"을(를) 참조하세요.
GitHub Enterprise에 대한 전역 웹후크 만들기
엔터프라이즈 소유자는 전역 웹후크를 만들어 엔터프라이즈 내에서 발생하는 이벤트를 구독할 수 있습니다.
GitHub 웹 인터페이스 또는 REST API를 사용하여 전역 웹후크를 만들 수 있습니다. REST API를 사용하여 전역 웹후크를 만드는 방법에 대한 자세한 내용은 "글로벌 웹후크에 대한 REST API 엔드포인트"을(를) 참조하세요.
-
GitHub Enterprise Server의 오른쪽 위 모서리에서 프로필 사진과 엔터프라이즈 설정을 차례로 클릭합니다.
-
페이지 왼쪽의 엔터프라이즈 계정 사이드바에서 설정을 클릭합니다.
-
" 설정"에서 후크를 클릭합니다.
-
웹후크 추가를 클릭합니다.
-
"페이로드 URL" 필드에 페이로드를 수신하려는 URL을 입력합니다.
-
필요에 따라 콘텐츠 형식 드롭다운 메뉴를 선택하고 웹후크 페이로드를 수신할 데이터 서식을 클릭합니다.
- application/json은
POST
요청의 본문으로 직접 JSON 페이로드를 전달합니다. - application/x-www-form-urlencoded는
payload
(이)라는 양식 매개 변수로 JSON 페이로드를 전송합니다.
- application/json은
-
필요에 따라 "비밀"에서
secret
키로 사용할 문자열을 입력합니다. 엔트로피가 높은 임의의 텍스트 문자열을 선택해야 합니다. 웹후크 비밀을 사용하여 들어오는 요청을 GitHub에서 시작된 요청으로만 제한할 수 있습니다. 자세한 내용은 "웹후크 제공 유효성 검사하기"을(를) 참조하세요. -
필요에 따라, 페이로드 URL이 HTTPS이고 페이로드를 제공할 때 GitHub Enterprise Server이(가) SSL 인증서를 확인하지 않기를 원하는 경우, "SSL 확인"에서 사용 중지를 선택합니다. SSL 확인에 대한 정보를 읽은 다음 내 웹후크가 안전하지 않을 수 있음을 이해합니다를 클릭합니다.
경고: SSL 확인은 후크 페이로드가 안전하게 전달되도록 하는 데 도움이 됩니다. SSL 확인을 사용하지 않도록 설정하는 것은 권장하지 않습니다.
-
"이 웹후크를 트리거할 이벤트는 무엇인가요?"에서 수신하려는 웹후크 유형을 선택합니다. 필요한 웹후크 이벤트만 구독해야 합니다.
-
이벤트를 각각 선택하겠습니다를 선택했다면 웹후크를 트리거할 이벤트를 선택합니다.
-
구성을 추가한 다음 웹후크를 즉시 활성화하려면 활성화를 선택합니다.
-
웹후크 추가를 클릭합니다.
GitHub App 웹후크 만들기
GitHub App의 소유자는 특정 이벤트가 발생할 때마다 알림을 받도록 앱을 웹후크 이벤트에 구독할 수 있습니다. 조직에서 조직 소유의 GitHub App에 대한 앱 관리자를 지정한 경우, 앱 관리자도 앱을 웹후크 이벤트에 구독할 수 있습니다. 자세한 내용은 "GitHub 앱에 웹후크 사용"을(를) 참조하세요.
각 GitHub App에는 하나의 웹후크가 있습니다. GitHub App 등록 시 웹후크를 구성하거나 기존 GitHub App 등록에 대한 웹후크 구성을 편집할 수 있습니다.
GitHub App 등록 시 웹후크를 구성하는 방법에 대한 자세한 내용은 "GitHub 앱 등록"을(를) 참조하세요.
기존 GitHub App 등록에 대한 웹후크를 구성하려면 다음을 수행합니다.
-
GitHub Enterprise Server의 페이지 오른쪽 위 모서리에서 프로필 사진을 클릭합니다.
-
계정 설정으로 이동합니다.
- 개인 계정 소유한 앱의 경우 설정을 클릭합니다.
- 조직이 소유한 앱의 경우:
- 사용자의 조직을 클릭합니다.
- 조직 오른쪽에서 설정을 클릭합니다.
-
왼쪽 사이드바에서 개발자 설정을 클릭합니다.
-
왼쪽 사이드바에서 GitHub Apps 을 클릭합니다.
-
웹후크를 구성하려는 GitHub App 옆에 있는 편집을 클릭합니다.
-
"웹후크"에서 활성화를 선택합니다.
-
"웹후크 URL"에서 페이로드를 수신하려는 URL을 입력합니다.
-
필요에 따라 "웹후크 비밀"에
secret
키로 사용할 문자열을 입력합니다. 엔트로피가 높은 임의의 텍스트 문자열을 선택해야 합니다. 웹후크 비밀을 사용하여 들어오는 요청을 GitHub에서 시작된 요청으로만 제한할 수 있습니다. 자세한 내용은 "웹후크 제공 유효성 검사하기"을(를) 참조하세요. -
변경 내용 저장을 클릭합니다.
-
사이드바에서 권한 및 이벤트를 클릭합니다.
-
GitHub App 등록에 대해 선택할 수 있는 특정 웹후크 이벤트는 앱에 대해 선택한 사용 권한 유형에 따라 결정됩니다. 먼저 앱에 부여할 사용 권한을 선택한 다음 해당 사용 권한 집합과 관련된 웹후크 이벤트에 앱을 구독할 수 있습니다.
"리포지토리 권한", "조직 권한", "계정 권한" 섹션에서 앱이 구독할 이벤트에 필요한 권한을 선택합니다. 자세한 내용은 "GitHub 앱의 권한 선택"을(를) 참조하세요. 권한을 변경할 때 고려해야 할 사항에 대한 자세한 내용은 "GitHub App 등록 수정하기"를 참조하세요.
-
"이벤트 구독"에서 GitHub App을(를) 받을 웹후크 이벤트를 선택합니다.
-
변경 내용 저장을 클릭합니다.
REST API를 사용하여 GitHub App에 대한 웹후크를 만들 수도 있습니다. 자세한 내용은 "GitHub App 웹후크에 대한 REST API 엔드포인트"을(를) 참조하세요.