웹훅(Webhook)

웹훅은 박스히어로에서 특정한 이벤트가 발생하였을 때, 실시간으로 알림을 받아볼 수 있는 기능입니다.

Webhook 등록

[결제 및 설정] - [외부 서비스 연동 & API] 메뉴에서 웹훅을 등록할 수 있습니다.

Webhook 핸들러

이벤트 발생시 등록된 Webhook Endpoint로 이벤트 본문을 전달합니다. webhook 핸들러 응답 status code가 200인 경우 정상적으로 수신하였다고 판단합니다. 만약 200이 아닌 status code가 반환되는 경우 일시적 에러로 간주하여 최대 3번까지 재시도 합니다.

이벤트 본문

이벤트 전달시 POST Body에 아래 데이터를 JSON 형태로 포함하여 전달합니다.

{
  "id": "1234", // 이벤트의 고유 ID
  "topic": "txs/new", // 이벤트 주제
  "version": 1, // 이벤트 본문의 버전
  "payload": { // 이벤트 본문
    ...
  },
  "created_time": "2024-08-06T09:20:48.623Z" // 이벤트 발생 시간
}

이벤트 순서

박스히어로는 이벤트의 전달 순서를 보장하지 않습니다. 예를들어 item/new 이벤트가 item/delete 이벤트 이후에 도착할 수 있습니다. 응답 본문의 created_time 필드가 이벤트의 실제 발생 시각을 의미하므로 이를 활용해 적절한 처리가 될 수 있도록 직접 구현하셔야 합니다.

이벤트 주제

추가로 필요한 주제가 있다면 고객센터로 요청주세요.

txs/new

재고 변동(입고/출고/조정/이동) 이벤트가 발생하였을때 발송됩니다.

필드명	필수 여부	팀 모드	설명
id		공통	히스토리의 고유 ID
type		공통	히스토리의 유형 (입고->in, 출고->out, 조정->adjust, 이동->move)
partner		공통	거래처
partner.id		공통	거래처의 고유 ID
partner.name		공통	거래처의 이름
partner.deleted		공통	삭제된 거래처 여부
from_location		위치	출발 위치
from_location.id		위치	위치의 고유 ID
from_location.name		위치	위치명
from_location.deleted		위치	삭제된 위치 여부
to_location		위치	도착 위치
to_location.id		위치	위치의 고유 ID
to_location.name		위치	위치명
to_location.deleted		위치	삭제된 위치 여부
items		공통	히스토리 품목
items.id		공통	제품의 고유 ID
items.name		공통	제품명
items.quantity		공통	입고/출고/조정/이동에 의한 재고의 변경량
items.deleted		공통	제품의 삭제 여부
items.new_stock_level		기본/유닛	히스토리가 반영된 이후의 재고 수량
items.from_location_new_stock_level		위치	히스토리가 반영된 이후, 출발 위치에서의 재고 수량
items.to_location_new_stock_level		위치	히스토리가 반영된 이후, 도착 위치에서의 재고 수량
transaction_time		공통	트랜잭션 시점(e.g. 입/출고 시간)
created_at		공통	히스토리가 작성된 시점
created_by		공통	히스토리를 생성한 멤버
created_by.id		공통	멤버의 고유 ID
created_by.name		공통	멤버의 이름
created_by.deleted		공통	탈퇴한 멤버 여부
count_of_items		공통	제품별 항목수
total_quantity		공통	재고 변동량의 총합
url		공통	히스토리 상세정보 페이지로 이동할 수 있는 주소
memo		공통	메모

이벤트 본문 예시 - 기본모드 팀에서 입고 이벤트가 발생함

{
  "id": 16160911,
  "type": "in",
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "new_stock_level": 40
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "new_stock_level": 207
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}

예시 - 위치모드 팀에서 이동 이벤트가 발생함

{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Warehouse 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Joy Kim",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

item/new

제품이 추가되었을 때 발송됩니다.

현재 옵션 일괄 추가 / 엑셀 대량 추가 기능 사용시에는 발송되지 않습니다.

필드명	설명
id	제품의 고유 ID
name	제품명
sku	거래처
barcode	거래처의 고유 ID
photo_url	거래처의 이름
cost	삭제된 거래처 여부
price	출발 위치
attrs	위치의 고유 ID

이벤트 본문 예시

{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Category",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Expiration date",
      "type": "date",
      "value": "2024-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

제품이 수정되었을 때 발송됩니다.

현재 엑셀 대량 수정 혹은 [데이터 관리] > [제품]에서의 대량 수정 기능 사용시에는 발송되지 않습니다.

필드명	설명
id	제품의 고유 ID
name	제품명
sku	거래처
barcode	거래처의 고유 ID
photo_url	거래처의 이름
cost	삭제된 거래처 여부
price	출발 위치
attrs	위치의 고유 ID

이벤트 본문 예시

{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Category",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Expiration date",
      "type": "date",
      "value": "2024-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

제품이 삭제되었을 때 발송됩니다.

현재 [데이터 관리] > [제품]에서의 대량 삭제 기능 사용시에는 발송되지 않습니다.

필드명	설명
id	제품의 고유 ID

이벤트 본문 예시

{
  "id": 26122826
}