웹후크는 특정 이벤트가 발생할 때 서비스가 등록한 URL로 전송하는 HTTP 요청입니다. 이는 시스템이 API를 반복적으로 호출하여 새로운 데이터가 있는지 확인하는 대신, 이벤트가 발생하는 즉시 데이터를 수신할 수 있게 해줍니다. 데이터 파이프라인에서는 소스가 보고하는 즉시 작업이 이벤트에 반응할 수 있다는 것을 의미합니다.
예를 들어, 결제 플랫폼 Stripe는 HTTPS를 통해 JSON 페이로드로 웹후크 이벤트를 귀하의 엔드포인트로 전송합니다. 귀하의 엔드포인트는 POST 요청을 수락하고 수신한 이벤트 데이터를 처리해야 합니다.
웹후크 전달 방식
Stripe의 문서에서는 주요 메커니즘을 보여줍니다:
- 등록: 엔드포인트 URL을 등록합니다. 라이브 모드에서는 Stripe가 공개적으로 접근 가능한 HTTPS URL을 요구합니다.
- 빠른 확인: 엔드포인트는 복잡한 논리로 인해 타임아웃이 발생하기 전에 신속하게 2xx 상태 코드를 반환해야 합니다.
- 재시도: 전달이 실패하면 Stripe는 라이브 모드에서 최대 3일 동안 지수 백오프 방식으로 재시도합니다.
- 순서: Stripe는 이벤트가 생성된 순서대로 도착할 것이라고 보장하지 않습니다.
웹후크 엔드포인트 보안
- 서명 확인: Stripe는 각 이벤트에 HMAC을 사용하여 SHA-256으로 서명하고
Stripe-Signature헤더에 서명을 포함합니다. - 재생 차단: 서명된 페이로드에는 타임스탬프가 포함되어 있어 너무 오래된 이벤트를 거부할 수 있습니다.
- 중복 처리: 엔드포인트는 동일한 이벤트를 여러 번 수신할 수 있습니다. 처리된 이벤트 ID를 기록하고 중복을 건너뜁니다.
- 허용 목록 발신자: Stripe는 방화벽을 제한할 수 있는 공개된 IP 주소 목록에서 웹후크를 전송합니다.
일반적인 웹후크 사용 사례
- 코드 및 배포: GitHub는 귀하가 구독하는 리포지토리 이벤트에 대해 귀하의 URL로 HTTP POST 페이로드를 전송합니다. 문서에는 CI 빌드 시작, 외부 문제 추적기 업데이트, 백업 미러 새로 고침 및 프로덕션 서버에 배포와 같은 사용 사례가 나열되어 있습니다.
- 결제: Stripe 웹후크를 사용하면 은행이 결제를 확인하거나 고객이 요금을 이의 제기하거나 정기 결제가 성공하는 등의 비동기 이벤트에 응답할 수 있습니다.
- 필요한 것만 구독: Stripe는 서버에 과도한 부담을 주기 때문에 추가 또는 모든 이벤트를 수신하는 것을 권장하지 않습니다.