Webhook

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

---

登録

Webhook を登録できます 設定 > 連携とAPI あなたの BoxHero チームで。

配信と再試行の動作

イベントが発生すると、BoxHero は HTTP POST リクエストを登録済みの webhook エンドポイントに送信します。リクエスト本文には、そのイベントを説明する 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		取引内の明細
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": "倉庫 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": "倉庫 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "倉庫 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		取引内の明細
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": "倉庫 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": "倉庫 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "倉庫 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
name	商品名
sku	SKU
barcode	バーコード
photo_url	写真URL
cost	原価
price	価格
attrs	属性

Webhook ペイロードの例 – 商品作成

{
  "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": "カテゴリ",
      "type": "text",
      "value": "ファンデーション"
    },
    {
      "id": 459264,
      "name": "有効期限",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "安全在庫",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

既存の商品が編集されたときに送信されます。

注: このイベントは ありません トリガーされます fまたは次を通じて行われた一括編集 データセンター > 商品 または次を通じて Excel インポート 機能。

項目	説明
id	商品ID
name	商品名
sku	SKU
barcode	バーコード
photo_url	写真URL
cost	原価
price	価格
attrs	属性

Webhook ペイロードの例 – 商品更新

{
  "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": "カテゴリ",
      "type": "text",
      "value": "ファンデーション"
    },
    {
      "id": 459264,
      "name": "有効期限",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "安全在庫",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

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

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

項目	説明
id	商品ID

ペイロードの例 – 商品削除

{
  "id": 26122826
}