웹훅 연동 가이드
웹훅 이용에 대한 문서입니다. 웹훅 설정과 테스트 방법, 제공되는 이벤트 리스트 전체를 확인할 수 있습니다.
웹훅(Webhook) 설정 방법
웹훅을 등록하려면 등록하고자 하는 웹훅이 속한 API Scope를 확인하고 해당 API Scope를 먼저 활성화해야 합니다.
웹훅 이용 안내
웹훅 이벤트 등록은 API 승인과 무관하게 API Scope를 활성화하면 가능하지만, 실제 이벤트를 전송받으려면 해당 웹훅 이벤트가 속한 API Scope에 대해 승인을 받아야 합니다.
웹훅 등록 시 제한 사항
하나의 이벤트에 대해 수신 URL을 1개만 등록할 수 있습니다. 동일한 이벤트에 대해 여러 URL은 등록이 불가합니다.
웹훅 테스트 방법
개발자 센터에 로그인한 후, 웹훅 페이지에서 웹훅을 등록하고 ‘테스트 내보내기’ 기능을 통해 테스트할 수 있습니다. 테스트 시에는 ‘테스트 보내기’ 화면에 표시된 샘플 데이터가 등록한 URL로 전송됩니다.
수신 가능 이벤트 및 필요 권한(Scope)
사이트에 발생하는 이벤트는 해당 앱이 승인받은 권한(Scope)에 해당하는 이벤트만 수신할 수 있습니다. 수신할 수 있는 전체 이벤트 및 필요한 권한 정보는 다음과 같습니다.
테스트 연동 사이트
테스트 연동 상태는 웹훅을 제공하지 않습니다.
※ 이벤트별 샘플 데이터는 개발자 센터 > 웹훅 페이지에서 테스트 보내기를 통해 확인할 수 있습니다.
사이트 정보 Site-Info
| 이벤트 타입 | 이벤트 |
|---|---|
| INTEGRATION_CANCELLATION | 사이트에서 앱이 연동 해제된 경우 |
회원 정보 Member-Info
| 이벤트 타입 | 이벤트 |
|---|---|
| END_USER_SIGN_UP | 회원이 생성된 경우 |
| END_USER_WITHDRAWAL | 회원이 삭제된 경우 |
| END_USER_INFO_UPDATE | 회원 정보가 수정된 경우1) |
| END_USER_AGREE_INFO_UPDATE | 회원 동의 정보가 수정된 경우 |
| END_USER_SIGN_UP_BULK | 회원이 일괄 등록된 경우2) |
| END_USER_GRADE_UPDATE | 회원 쇼핑 등급이 변경된 경우 |
| END_USER_CART_ADD | 회원이 장바구니에 상품을 담은 경우3) |
1) 회원 정보가 수정된 경우 : 회원 정보는 사이트마다 매우 상이하여 공통된 정보인 주소, 생년월일, 전화번호, 이름이 변경된 경우에만 발송됩니다.
2) 회원 일괄 등록된 경우 : 아임웹 시스템 내에서 엑셀 파일로 회원을 일괄 등록하는 경우에 해당합니다. 50명 단위로 나뉘어 전달됩니다.
3) 비회원(미로그인 상태)의 경우 전송되지 않습니다.
프로모션 Promotion
| 이벤트 타입 | 이벤트 |
|---|---|
| END_USER_POINT_CHANGE | 회원에게 적립금이 지급/차감된 경우 |
| END_USER_POINT_GROUP_CHANGE | 회원 그룹별로 적립금이 지급/차감된 경우 |
상품 Product
| 이벤트 타입 | 이벤트 |
|---|---|
| SITE_ADMIN_SERVICE_PRODUCT_DELETE | 상품이 삭제된 경우 |
주문 Order
| 이벤트 타입 | 이벤트 |
|---|---|
| ORDER_CREATE | 주문이 생성된 경우 |
| ORDER_DEPOSIT_COMPLETE | 주문이 입금 완료된 경우 |
| ORDER_PRODUCT_PREPARATION | 주문의 섹션이 상품 준비가 된 경우 |
| ORDER_SHIPPING_READY | 주문의 섹션이 배송대기가 된 경우 |
| ORDER_SHIPPING | 주문의 섹션이 배송중이 된 경우 |
| ORDER_SHIPPING_COMPLETE | 주문의 섹션이 배송완료가 된 경우 |
| ORDER_INVOICE_REGISTERED | 주문의 섹션에 운송장이 등록된 경우 |
| ORDER_INVOICE_UPDATED | 주문의 섹션에 등록된 운송장이 수정된 경우 |
| ORDER_INVOICE_DELETED | 주문의 섹션에 등록된 운송장이 삭제된 경우 |
| ORDER_DEPOSIT_COMPLETE | 주문의 입금이 완료된 경우 |
| ORDER_CANCEL_REQUEST | 주문의 섹션이 취소 접수된 경우 |
| ORDER_CANCEL_WITHDRAW | 주문의 섹션이 취소 철회된 경우 |
| ORDER_CANCEL_COMPLETE | 주문의 섹션이 취소 완료된 경우 |
| ORDER_CANCEL_REJECT | 주문의 섹션이 취소 거절된 경우 |
| ORDER_RETURN_REQUEST | 주문의 섹션이 반품 접수된 경우 |
| ORDER_RETURN_COLLECTING | 주문의 섹션이 반품 수거중이 된 경우 |
| ORDER_RETURN_COLLECTED | 주문의 섹션이 반품 수거완료된 경우 |
| ORDER_RETURN_WITHDRAW | 주문의 섹션이 반품 철회된 경우 |
| ORDER_RETURN_COMPLETE | 주문의 섹션이 반품 완료된 경우 |
| ORDER_RETURN_REJECT | 주문의 섹션이 반품 거절된 경우 |
| ORDER_EXCHANGE_REQUEST | 주문의 섹션이 교환 접수된 경우 |
| ORDER_EXCHANGE_COLLECTING | 주문의 섹션이 교환 수거중이 된 경우 |
| ORDER_EXCHANGE_COLLECTED | 주문의 섹션이 교환 수거완료된 경우 |
| ORDER_EXCHANGE_WITHDRAW | 주문의 섹션이 교환 철회된 경우 |
| ORDER_EXCHANGE_COMPLETE | 주문의 섹션이 교환 승인된 경우 |
| ORDER_EXCHANGE_REJECT | 주문의 섹션이 교환 거절된 경우 |
| ORDER_EXCHANGE_PRODUCT_PREPARATION | 주문의 섹션이 교환 상품 준비가 된 경우 |
| ORDER_EXCHANGE_SHIPPING_READY | 주문의 섹션이 교환 배송대기가 된 경우 |
| ORDER_EXCHANGE_SHIPPING | 주문의 섹션이 교환 배송중이 된 경우 |
| ORDER_EXCHANGE_SHIPPING_COMPLETE | 주문의 섹션이 교환 배송완료가 된 경우 |
결제 Payment
| 이벤트 타입 | 이벤트 |
|---|---|
| ORDER_REFUND | 주문의 환불이 완료된 경우 |
