메인 콘텐츠로 건너뛰기
POST
/
v1
/
server
/
webhooks
웹훅 등록
curl --request POST \
  --url https://sdk-api.playcamp.io/v1/server/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "coupon.redeemed",
  "url": "<string>",
  "retryCount": 3,
  "timeoutMs": 5000
}
'
{
  "data": {
    "id": 123,
    "eventType": "coupon.redeemed",
    "url": "<string>",
    "isActive": true,
    "retryCount": 123,
    "timeoutMs": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

인증

Authorization
string
header
필수

Server API Key (format: {keyId}:{secret})

본문

application/json
eventType
enum<string>
필수

웹훅 이벤트 타입:

  • coupon.redeemed: 쿠폰 사용
  • payment.created: 결제 생성
  • sponsor.created: 후원 생성
사용 가능한 옵션:
coupon.redeemed,
payment.created,
sponsor.created
url
string<uri>
필수

웹훅 수신 URL

retryCount
integer
기본값:3

실패 시 재시도 횟수

필수 범위: 0 <= x <= 10
timeoutMs
integer
기본값:5000

타임아웃 (밀리초)

필수 범위: 1000 <= x <= 30000

응답

201 - application/json

성공 (secret은 이 응답에서만 반환됨)

data
object
필수

웹훅 생성 응답 (secret 포함)