sayren Docs
웹훅

웹훅 테스트 이벤트 발송

지정한 이벤트 타입의 샘플 페이로드(이벤트 ID `evt_test_…`)를 실제 발송 형식·서명 그대로 구독 URL에 한 번 보내고 수신 서버의 응답을 동기로 반환한다. 재시도·정지 판정·전송 기록이 없다. 타임아웃은 10초다.

POST
/v1/webhooks/{webhookId}/test

지정한 이벤트 타입의 샘플 페이로드(이벤트 ID evt_test_…)를 실제 발송 형식·서명 그대로 구독 URL에 한 번 보내고 수신 서버의 응답을 동기로 반환한다. 재시도·정지 판정·전송 기록이 없다. 타임아웃은 10초다.

Authorization

accessToken
headerAuthorizationBearer <token>

Sayren 계정 토큰(로그인 토큰 또는 개인 액세스 토큰, RFC 9068 JWT)

Path Parameters

webhookId*string

Header Parameters

X-Store-Id*string

대상 상점 id. 토큰의 상점 범위 밖이면 403 STORE_NOT_GRANTED, 없으면 400 STORE_ID_REQUIRED다

Request Body

application/json
  1. body
eventType*string

샘플 페이로드로 보낼 이벤트 타입

Value in"ORDER.PAID""ORDER.CONFIRMED""ORDER.DISPATCHED""ORDER.DELIVERED""ORDER.PURCHASE_DECIDED""ORDER.ADDRESS_CHANGE_REQUESTED""ORDER.CANCELED""ORDER.FULFILLED""CLAIM.CANCEL_REQUESTED""CLAIM.RETURN_REQUESTED""CLAIM.EXCHANGE_REQUESTED""CLAIM.COMPLETED""INQUIRY.CREATED""REVIEW.CREATED""PRODUCT.OUT_OF_STOCK""ORDER.FLOW_NOTIFICATION""ORDER.FLOW_STATE_CHANGED"

Response Body

성공

application/json
  1. response
meta*
data*
error*|null
curl -X POST 'https://api.sayren.io/v1/webhooks/string/test' \  -H 'X-Store-Id: string' \  -H 'Content-Type: application/json' \  -d '{  "eventType": "ORDER.PAID"}'
{  "meta": {    "status": 200,    "code": "OK",    "message": "OK",    "isSuccess": true  },  "data": {    "responseStatusCode": 0,    "responseTimeMs": 0,    "errorCode": "TIMEOUT",    "failureReason": "string",    "responseBodyExcerpt": "string",    "requestHeaders": [      {        "name": "string",        "value": "string"      }    ],    "payload": "string"  },  "error": null}