데이터스페이스에 등록한 웹훅에 대해 정보 확인, 정보 변경 및 삭제, 전송 내역 확인 및 이벤트 재발송 등을 할 수 있습니다. 이와 같은 웹훅 관리는 데이터스페이스 왼쪽 GNB에서 설정 > 개발 연동 > 웹훅에서 관리할 수 있습니다. 아래에서 좀 더 상세한 웹훅 관리 방법을 안내합니다.
웹훅 연동 가이드는 아래 아티클을 먼저 확인해 주세요.
등록한 웹훅 관리하기
웹훅 설정은 스페이스 내 Developer 권한을 가지고 있는 멤버만 가능합니다. 필요 시 Admin 멤버에게 문의하여 권한을 먼저 받아 주세요.
① 웹훅 정보 확인하기
먼저 ‘웹훅 목록‘에서는 등록한 웹훅 기본 정보와 리스트를 확인할 수 있습니다.
이 중 웹훅을 선택하면 ‘웹훅 정보’ 영역에서 보다 상세한 정보가 확인됩니다. 각 항목의 정보는 아래와 같습니다.
이름: 웹훅 등록 및 수정 시 지정한 이름값이 노출됩니다.
상태: 웹훅의 활성화 상태를 노출합니다.
활성화: 등록한 웹훅이 활성화된 상태입니다. 이벤트가 발생하면 등록된 URL로 전송합니다.
중지: 등록한 웹훅이 시스템에 의해 중지된 상태입니다. 이벤트를 쌓아두지만 등록된 URL로 전송하지 않습니다.
비활성화: 등록한 웹훅이 사용자 요청에 의해 비활성화된 상태입니다. 해당 상태에서는 이벤트를 쌓아두지 않습니다.
오류율: ‘웹훅 목록’에는 최근 30일 기준으로 집계된 오류율을 노출합니다.
전일: 직전 날짜의 전송 시도 건 중 실패 건의 비율을 구한 값입니다. 백분율 형태로 표시되며 매일 오전 9시마다 갱신됩니다. 단, 전일 전송 시도 건이 30건 미만일 경우 집계되지 않습니다.
최근 30일: 최근 30일간의 전송 시도 건 중 실패 건의 비율을 구한 값입니다. 백분율 형태로 표시되며 매일 오전 9시마다 갱신됩니다. 최근 30일간의 전송 시도 건수와 무관하게 집계됩니다.
📌 어떤 상황에서 웹훅이 중지 상태가 되나요?
매일 오전 9시에 전일 오류율 집계 바탕으로 전일 전송 시도 건이 30건 이상이고, 전일 오류율이 10% 이상이라면 웹훅을 자동 중지시킵니다.
중지 상태로 변경된 경우 해당 스페이스의 Developer 멤버에게 이메일로 안내되니 이메일을 지속적으로 확인할 수 있는 멤버 1명 이상의 Developer 권한 유지를 권장합니다.
URL: 웹훅 등록 및 수정 시 지정한 URL입니다. 설정한 이벤트가 발생하면 해당 URL로 웹훅이 전송됩니다.
이벤트 타입: 웹훅 등록 시 지정한 이벤트 타입입니다.
최근 전송 일시: 해당 웹훅에서 전송을 시도한 가장 최근 일시입니다.
HMAC: 웹훅 유효성 검사 사용 여부를 확인할 수 있습니다.
② 웹훅 정보 변경 및 삭제하기
‘웹훅 정보’ 영역에서 웹훅 이름·활성화 상태·URL·HMAC 설정을 변경하거나, 웹훅을 삭제할 수 있습니다. 단, URL·HMAC 설정 변경과 웹훅 삭제는 비활성화 상태에서 가능하니 상태 변경을 먼저 확인 및 진행해 주세요.
③ URL 테스트 하기
‘웹훅 정보’ 영역에서 URL 등록이 정상적으로 되었는지 테스트 할 수 있습니다. [테스트] 버튼 선택 시 해당 URL로 임의 값을 전송합니다.
④ 웹훅 전송 내역 확인하기
‘전송 내역’ 영역에서 해당 웹훅의 전송 내역을 확인할 수 있습니다. 전송 내역은 최근 30일 내역까지만 제공합니다. 각 항목의 정보는 아래와 같습니다.
이벤트 발생 일시: 트리거한 이벤트가 발생한 일시입니다.
이벤트 ID: 트리거한 이벤트의 고유 ID입니다. 전송 내역에 대한 CS 접수 시 해당 정보를 제공하면 더욱 빠른 지원을 받을 수 있습니다.
상태: 트리거한 이벤트에 대한 웹훅 전송 상태입니다.
전송 준비: 성공 이력이 없지만, 자동 재전송 횟수가 남아있는 상태입니다.
성공: 성공 이력이 있는 상태입니다.
실패: 자동 재전송을 마쳤으나, 성공 이력이 없는 상태입니다.
📌 꼭 알아두세요!
웹훅 전송 시, 요청에 대한 응답이 5초 내에 완료되지 않으면 요청은 타임아웃으로 처리됩니다.
데이터스페이스는 웹훅 전송에 실패하더라도, 동일한 이벤트에 대해 최대 4번까지 자동으로 재전송합니다.
재전송 횟수 ㅣ 재전송 간격(초)
1 15
2 30
3 60
4 120
⑤ 실패한 이벤트 재시도하기
‘전송 내역’ 영역에서 전송 실패한 이벤트에 대해 [재시도]를 선택할 수 있습니다. 모든 실패 상태에 이벤트 재전송이 필요하다면 오른쪽 상단의 [전체 재시도] 버튼을 선택해 주세요.
또한, 이벤트별 전송 시도 이력 및 오류코드 조회를 보고 싶다면 오른쪽 ‘상세 정보’를 선택하면 확인할 수 있습니다. 해당 화면에서도 [재시도]가 가능합니다.
⑥ Payload 정보 확인하기
‘전송 내역’ 영역에서 Payload 조회가 필요한 이벤트의 ‘상세 정보’ 누른 후 [Payload] 탭을 선택해 주세요. JSON 다운로드를 지원하므로 디버깅 또는 데이터 별도 저장에 활용할 수 있습니다