Webhook

Webhookは、BoxHeroで特定のイベントが発生したときにリアルタイム通知を受け取れる機能です。

---

登録

Webhook を 設定 > 連携 & API の BoxHero チームに登録できます。

配信と再試行の動作

イベントが発生すると、BoxHero はあなたの登録済み webhook エンドポイントに HTTP POST リクエストを送信します。リクエストボディには、そのイベントを説明する JSON ペイロードが含まれます。

• サーバーが HTTP 200 OKを返すと、そのイベントは正常に配信されたものとみなされます。

• サーバーが 200 以外のステータスコードの場合、BoxHero はそれを一時的な失敗として扱い、最大 3 回まで再配信を試みます。

Webhook ペイロード構造

すべての webhook イベントは、リクエストボディ内で次の JSON 構造で配信されます:

{
  "id": "1234", // イベントの一意な ID
  "topic": "txs/new", // イベントのトピック
  "version": 1, // ペイロードスキーマのバージョン
  "payload": { // イベント固有のデータ
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // イベント発生時刻のタイムスタンプ（ISO 8601）
}

---

イベントの順序

BoxHero 保証しません イベント配信の順序を。たとえば、 item/new イベントは、同じアイテムの item/delete イベントの後に届くことがあります。

チーム created_time フィールドは、実際のイベント時刻を表します。イベントを確実に処理するために、Webhook ハンドラーには冪等で順序に耐性のあるロジックを実装してください。

イベントトピック

追加のイベントトピックのサポートが必要な場合は、 サポート.

txs/new

在庫取引が発生したときにトリガーされます（入庫 / 出庫 / 在庫調整 / 在庫移動）。

注： このイベントは ありません 一括編集やインポートで作成された調整に対してトリガーされます（例: Excel でアイテムを追加または更新した場合）。

項目	必須	説明
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.id		アイテムの一意な ID
items.name		アイテム名
items.quantity		入庫/出庫/調整/移動による在庫変動
items.deleted		そのアイテムが削除済みかどうか
items.from_location_new_stock_level		取引後の元の場所での在庫数
items.to_location_new_stock_level		取引後の移動先での在庫数
transaction_time		取引時刻（例: 入庫/出庫時刻）
created_at		取引が作成された時刻
created_by		取引を作成したメンバー
created_by.id		メンバーの一意な ID
created_by.name		メンバー名
created_by.deleted		そのメンバーが削除済みかどうか
count_of_items		アイテム数
total_quantity		在庫変動の合計数量
url		取引詳細ページを表示するための URL アドレス
memo		取引に関するメモ

Webhook ペイロード例 – 入庫 イベント

{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "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"
}

Webhook ペイロード例 – 在庫移動 イベント

{
  "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": "2025-04-25T05:42:27.545Z",
  "created_at": "2025-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Tony Lee",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

txs/edit

既存の在庫取引（入庫 / 出庫 / 在庫調整 / 在庫移動）が 編集されたときに送信されます.

項目	必須	説明
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.id		アイテムの一意な ID
items.name		アイテム名
items.quantity		取引による数量変動（入庫/出庫/調整/移動）
items.deleted		そのアイテムが削除済みかどうか
items.from_location_new_stock_level		取引後の元の場所での在庫数
items.to_location_new_stock_level		取引後の移動先での在庫数
transaction_time		取引時刻（例: 入庫/出庫時刻）
created_at		取引が作成された時刻
created_by		取引を作成したメンバー
created_by.id		メンバーの一意な ID
created_by.name		メンバー名
created_by.deleted		そのメンバーが削除済みかどうか
count_of_items		アイテム数
total_quantity		在庫変動の合計数量
url		取引詳細ページを表示するための URL アドレス
memo		取引に関するメモ
revision		取引の現在のバージョン番号。1 から開始します

Webhook ペイロード例 – 編集済み 入庫 取引

{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "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"
}

Webhook ペイロード例 – 編集済み 在庫移動 取引

{
  "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"
}

txs/delete

在庫取引が 削除されたときに送信されます.

項目	説明
id	取引の一意な ID
revision	取引の現在のバージョン番号。1 から開始します

Webhook ペイロード例 – 削除された取引

/{
  "id": 27036740,
  "revision": 2
}

item/new

チームの在庫に新しいアイテムが追加されたときに送信されます。

注: このイベントは ありません を使用するとき、または次の方法でアイテムをインポートするときにトリガーされます アイテムバリアントを追加 機能、または次の方法でインポートしたとき Excelインポート.

項目	説明
id	アイテム ID
名前	アイテム名
sku	SKU
バーコード	バーコード
photo_url	写真 URL
原価	原価
価格	価格
attrs	属性

例のペイロード – アイテム作成

{
  "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": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

既存のアイテムが編集されたときに送信されます。

注: このイベントは ありません トリガーされます fまたは次を通じた一括編集 データセンター > アイテム または次を通じて Excelインポート 機能を使って複数のアイテムを一度に追加できます。

項目	説明
id	アイテム ID
名前	アイテム名
sku	SKU
バーコード	バーコード
photo_url	写真 URL
原価	原価
価格	価格
attrs	属性

例のペイロード – アイテム更新

{
  "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": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

アイテムがチームの在庫から削除されたときに送信されます。

注: このイベントは ありません 次を通じた一括削除でトリガーされます データセンター > アイテム.

項目	説明
id	アイテム ID

例のペイロード – アイテム削除

{
  "id": 26122826
}