웹훅 조회

GET

/api/v1/webhooks/{webhook_id}

const url = 'https://dev.api.endueos.com/api/v1/webhooks/whk_01J9ZK3Q8M4XW7D2N5R6T0V1BC';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev.api.endueos.com/api/v1/webhooks/whk_01J9ZK3Q8M4XW7D2N5R6T0V1BC \
  --header 'Authorization: Bearer <token>'

가이드 — 이벤트와 웹훅

인증

파라미터

경로 파라미터

webhook_id

필수

string

/^whk_[0-9A-HJKMNP-TV-Z]{26}$/

예시

whk_01J9ZK3Q8M4XW7D2N5R6T0V1BC

응답

200

성공.

application/json

object

data

필수

object

webhook_id

필수

string

/^whk_[0-9A-HJKMNP-TV-Z]{26}$/

station_id

필수

string

/^stn_[0-9A-HJKMNP-TV-Z]{26}$/

url

필수

string

events

필수

EventType 값 또는 command.* 같은 접두사 와일드카드. command.progress 는 웹훅으로 가지 않는다.

Array<string>

resource_ids

필수

Any of:

Array<string>
null

Array<string>

status

필수

string

허용 값: active paused

consecutive_failures

필수

integer format: int32

last_delivered_at

필수

Any of:

string
null

string format: date-time

created_at

필수

string format: date-time

updated_at

필수

string format: date-time

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

예시

{
  "data": {
    "webhook_id": "whk_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "station_id": "stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "resource_ids": [
      "res_01J9ZK3Q8M4XW7D2N5R6T0V1BC"
    ],
    "status": "active"
  }
}

401

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

404

없거나 내 것이 아니다 — *_NOT_FOUND. 본문은 오류 봉투.

429

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

500

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

503

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.