튜토리얼

본 가이드는 Ruby 개발환경에서 홈택스연동 웹훅을 구현하는 예시입니다.
고객사는 [Webhook 프로세스] 를 참고하여 개발을 진행합니다.

개발 가이드 샘플

팝빌 Webhook 메시지 수신을 Rails 프레임워크를 통해 구현한 Controller 함수 예제코드입니다.
수신 URL에 대한 Rails URL 매핑 설정은 연동사 환경에 따라 상이할 수 있습니다.
Webhook 이벤트 메시지의 추가적인 항목은 하단의 [Webhook 메시지 구성]을 참조하시기 바랍니다.

skip_before_action :verify_authenticity_token

def connect

  puts params[:eventDT] # Webhook 이벤트 실행일시
  puts params[:eventType] # Webhook 이벤트 유형

  # 추가적인 항목은 [Webhook 메시지 구성] 참조

  # Webhook 수신 성공처리
  render :json => {:result => "OK"}
end

응답결과

고객사는 전송 받은 웹훅 처리결과를 팝빌에 HTTP Response로 반환합니다. 팝빌은 고객사가 반환한 결과값을 바탕으로 성공 여부를 확인합니다. 성공을 제외한 모든 응답은 팝빌에서 실패로 간주하며 재시도 합니다.

1. 성공

고객사는 웹훅을 정상적으로 전송 받은 경우 Response Body를 String 또는 JSON 타입 중 선택하여 다음과 같이 반환합니다.

2. 실패 및 재시도

고객사의 서버로 웹훅이 전송되지 않은 경우 팝빌에서 [재전송정책] 에 따라 총 4회 자동 전송 됩니다.
최종 시도에도 실패된 웹훅은 팝빌 기술지원센터에서 사전에 고객사와 협의된 채널(유선,메일)을 통해 안내하고 있습니다.

Webhook 실행내역 확인

고객사는 전송 받은 웹훅 처리결과를 팝빌에 HTTP Response로 반환합니다. 팝빌은 고객사가 반환한 결과값을 바탕으로 성공 여부를 확인합니다. 성공을 제외한 모든 응답은 팝빌에서 실패로 간주하며 재시도 합니다.

팝빌 테스트 사이트(test.popbill.com) 로그인 > API 상품 선택 > Webhook 관리 > 실행내역 메뉴로 이동