sayren Docs
웹훅

웹훅 구독 등록

판매자당 최대 10개. 등록 즉시 `ACTIVE`이며 이후 발생하는 구독 이벤트부터 발송된다. URL은 HTTPS여야 하고, 호스트가 사설·루프백·링크로컬 등 내부 주소로 해석되면 거부된다. 서명 시크릿 평문(`secret`)은 이 응답에서만 노출되고, 이후 조회에는 앞부분(`secretPrefix`)만 나온다.

POST
/v1/webhooks

판매자당 최대 10개. 등록 즉시 ACTIVE이며 이후 발생하는 구독 이벤트부터 발송된다. URL은 HTTPS여야 하고, 호스트가 사설·루프백·링크로컬 등 내부 주소로 해석되면 거부된다. 서명 시크릿 평문(secret)은 이 응답에서만 노출되고, 이후 조회에는 앞부분(secretPrefix)만 나온다.

AuthorizationBearer <token>

userToken(계정 스코프) 또는 storeToken(스토어 스코프)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string
Match^https:\/\/.*
Formatstarts_with
eventTypes*array<>
Items1 <= items

Response Body

application/json

curl -X POST "https://example.com/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "string",    "eventTypes": [      "ORDER.PAID"    ]  }'
{  "meta": {    "status": 201,    "code": "OK",    "message": "OK",    "isSuccess": true  },  "data": {    "webhookId": "string",    "url": "http://example.com",    "eventTypes": [      "ORDER.PAID"    ],    "status": "ACTIVE",    "secretPrefix": "string",    "suspendedAt": "string",    "createdAt": "string",    "secret": "string"  },  "error": null}