BuzzBooster는 커스텀 이벤트를 연동하기 위한 방법으로 SDK 를 통한 방법과 server-to-server API 를 통한 방법을 제공합니다. 이 문서에서는 server-to-server API 스펙에 대해 설명합니다.

SDK를 통한 이벤트 연동 방법은 SDK 연동 가이드를 참고해주세요.

API spec

POST /events

endpoint: <https://api.buzzvil.com/buzzbooster/events>

<aside> 💡 /events API 를 사용하기 위해 서버의 고정 IP 주소 등록이 필요합니다. [email protected] 로 연락주세요.

</aside>

Request Body

key	type	비고
event_id	UUID string, required	event 식별자, 중복 체크 시 사용
partner_id	string	BuzzBooster 연동 고객사 id
user_id	string, required	BuzzBooster 연동 user_id
event_name	string, required	BuzzBooster 서버 내부에서 predefined 된 이벤트 명은 사용할 수 없습니다.

predefined event 목록
- naverpay_conversion_success
- naverpay_conversion_cancel
- continuous_attendance
- random_attendance
- random_continuous
- bonus_attendance
- daily_attendance
- daily_reward
- secret_attendance_0, secret_attendance_1
- inviter, invitee
- roulette_event
- scratch_lottery_event
- stamp_participate_click

Response

status code	비고
200	정상
400	request body 에러
403	ip 인증 에러
409	event_id 중복 에러
500	서버에러

400 상태코드의 경우 관련된 에러코드/메시지를 json 형식으로 응답합니다.

properties
- error_code : integer
  에러 코드
- error_message : string
  상세 에러 메시지
  
에러 종류
error code 1 : response body 오류 시
error code 2 : 내부 이벤트명 사용시
error code 3 : 등록되지 않은 고객사
error code 4 : BuzzBooster에 등록되지 않은 유저