테마
웹훅 수신 & 이벤트 구독
식스샵 프로 플랫폼에서 제공하는 이벤트를 구독하거나 웹훅(콜백)성 연동 과정에서 필요한 API 엔드포인트를 앱에서 등록할 수 있어요.
호출받을 엔드포인트 등록
- 앱 개발자 센터에서 설정하려는 앱의 API 목록 페이지로 이동해주세요.
- API 추가하기 버튼을 클릭해주세요.
- 호출받을 엔드포인트(HTTP Method, Service Path)를 입력해주세요 – HTTP Method 는 특별한 상황이 아니라면 POST 로 설정해주세요.
- 이벤트를 구독하려는 경우 Receiver 항목에서 구독하려는 이벤트를 입력해주세요.
- 한 줄 설명 항목에 API에 대한 간단한 설명을 입력해주세요.
- 저장 버튼을 눌러 설정을 저장해주세요.
저장이 완료된 뒤에 앱이 설치된 스토어에서 구독한 이벤트가 발생하면 설정한 앱 서버의 엔드포인트가 호출돼요.
ℹ️ 앱 서버 호스트가 설정되어 있어야 해요
엔드포인트를 등록하기 위해서는 앱 동작 설정의 앱 서버 호스트가 설정되어 있어야 해요.
전달받은 이벤트 처리
이벤트가 발생하면 앱 서버의 엔드포인트로 요청이 발생해요.
yaml
# Headers
SS-Store-ID: <STORE_ID> # 스토어 ID
# Body (application/json)
{
... # 이벤트에 따라 상이
}- 요청은 스토어별로 전달되고,
SS-Store-ID헤더로 스토어를 구분할 수 있어요. - 이벤트 호출에 대해
5xx상태 코드가 반환되면 전달 실패로 보고 약 30분 간격으로 N회(이벤트에 따라 상이) 재호출이 일어나며, 마지막 재호출에서도 실패(5xx)하면 재호출이 최종 중단돼요. - 스토어에 앱이 설치되어 있지 않은 경우에는 이벤트가 발생해도 앱 서버의 엔드포인트로 요청이 전달되지 않아요.
지원 이벤트 목록
제공 중인 이벤트 목록과 설명은 다음의 문서들을 참고해주세요.
