Webhook

Webhooks เป็นฟีเจอร์ที่ช่วยให้คุณรับการแจ้งเตือนแบบเรียลไทม์เมื่อมีเหตุการณ์บางอย่างเกิดขึ้นใน BoxHero

---

การลงทะเบียน

คุณสามารถลงทะเบียนเว็บฮุกได้ที่ การตั้งค่า > การเชื่อมต่อและ API ในทีม BoxHero ของคุณ

พฤติกรรมการส่งและการลองใหม่

เมื่อเกิดเหตุการณ์ BoxHero จะส่งคำขอ HTTP POST ไปยังปลายทางเว็บฮุกที่คุณลงทะเบียนไว้ เนื้อหาของคำขอจะมีเพย์โหลด JSON ที่อธิบายเหตุการณ์นั้น

• หากเซิร์ฟเวอร์ตอบกลับด้วย HTTP 200 OKเหตุการณ์นั้นจะถือว่าส่งสำเร็จ

• หากเซิร์ฟเวอร์ตอบกลับด้วย รหัสสถานะใดๆ ที่ไม่ใช่ 200BoxHero จะถือว่าเป็นความล้มเหลวชั่วคราวและจะลองส่งซ้ำได้สูงสุด 3 ครั้ง

โครงสร้างเพย์โหลดของเว็บฮุก

เหตุการณ์เว็บฮุกทั้งหมดจะถูกส่งพร้อมโครงสร้าง JSON ต่อไปนี้ในเนื้อหาของคำขอ:

{
  "id": "1234", // รหัสเฉพาะของเหตุการณ์
  "topic": "txs/new", // หัวข้อของเหตุการณ์
  "version": 1, // เวอร์ชันสคีมาของเพย์โหลด
  "payload": { // ข้อมูลเฉพาะของเหตุการณ์
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // เวลาที่เกิดเหตุการณ์ (ISO 8601)
}

---

ลำดับของเหตุการณ์

BoxHero ไม่ รับประกันลำดับการส่งเหตุการณ์ ตัวอย่างเช่น เหตุการณ์ item/new อาจมาถึงหลังจากเหตุการณ์ item/delete สำหรับรายการเดียวกัน

แผน created_time ฟิลด์ในเพย์โหลดของเหตุการณ์แสดงเวลาจริงของเหตุการณ์นั้น ควรใช้ตรรกะแบบ idempotent และทนต่อการสลับลำดับในตัวจัดการเว็บฮุกของคุณเพื่อรองรับเหตุการณ์อย่างน่าเชื่อถือ

หัวข้อของเหตุการณ์

หากคุณต้องการการรองรับหัวข้อเหตุการณ์เพิ่มเติม โปรดติดต่อ ฝ่ายสนับสนุน.

txs/new

ถูกเรียกเมื่อมีธุรกรรมสินค้าคงคลังเกิดขึ้น (รับเข้า / จ่ายออก / ปรับสต็อก / ย้ายสต็อก)

หมายเหตุ: เหตุการณ์นี้ ไม่ ถูกเรียกสำหรับการปรับที่สร้างผ่านการแก้ไขจำนวนมากหรือการนำเข้า (เช่น เมื่อเพิ่มหรืออัปเดตรายการผ่าน Excel)

ฟิลด์	จำเป็น	คำอธิบาย
id		รหัสเฉพาะของธุรกรรม
type		ประเภทของธุรกรรม (in, out, adjust, move)
คู่ค้า		คู่ค้า
partner.id		รหัสเฉพาะของคู่ค้า
partner.name		ชื่อของคู่ค้า
partner.deleted		ระบุว่าคู่ค้าถูกลบหรือไม่
from_location		ตำแหน่งต้นทาง
from_location.id		รหัสเฉพาะของตำแหน่งต้นทาง
from_location.name		ชื่อตำแหน่งต้นทาง
from_location.deleted		ระบุว่าตำแหน่งต้นทางถูกลบหรือไม่
to_location		ตำแหน่งปลายทาง
to_location.id		รหัสเฉพาะของตำแหน่งปลายทาง
to_location.name		ชื่อตำแหน่งปลายทาง
to_location.deleted		ระบุว่าตำแหน่งปลายทางถูกลบหรือไม่
items		รายการสินค้าในธุรกรรม
items.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		รหัสเฉพาะของสมาชิก
created_by.name		ชื่อสมาชิก
created_by.deleted		ระบุว่าสมาชิกถูกลบหรือไม่
count_of_items		จำนวนรายการสินค้า
total_quantity		ปริมาณรวมของการเปลี่ยนแปลงสต็อก
url		ที่อยู่ URL สำหรับดูหน้ารายละเอียดธุรกรรม
memo		หมายเหตุที่เกี่ยวข้องกับธุรกรรม

ตัวอย่างเพย์โหลดเว็บฮุก – รับเข้า เหตุการณ์

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

ตัวอย่างเพย์โหลดเว็บฮุก – ย้ายสต็อก เหตุการณ์

{
  "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		รหัสเฉพาะของธุรกรรม
type		ประเภทของธุรกรรม (in, out, adjust, move)
คู่ค้า		คู่ค้า
partner.id		รหัสเฉพาะของคู่ค้า
partner.name		ชื่อของคู่ค้า
partner.deleted		ระบุว่าคู่ค้าถูกลบหรือไม่
from_location		ตำแหน่งต้นทาง
from_location.id		รหัสเฉพาะของตำแหน่งต้นทาง
from_location.name		ชื่อตำแหน่งต้นทาง
from_location.deleted		ระบุว่าตำแหน่งต้นทางถูกลบหรือไม่
to_location		ตำแหน่งปลายทาง
to_location.id		รหัสเฉพาะของตำแหน่งปลายทาง
to_location.name		ชื่อตำแหน่งปลายทาง
to_location.deleted		ระบุว่าตำแหน่งปลายทางถูกลบหรือไม่
items		รายการสินค้าในธุรกรรม
items.id		รหัสเฉพาะของรายการสินค้า
items.name		ชื่อสินค้า
items.quantity		การเปลี่ยนแปลงจำนวนจากธุรกรรม (in/out/adjust/move)
items.deleted		ระบุว่าสินค้าถูกลบหรือไม่
items.from_location_new_stock_level		ระดับสต็อกที่ตำแหน่งต้นทางหลังจากทำธุรกรรม
items.to_location_new_stock_level		ระดับสต็อกที่ตำแหน่งปลายทางหลังจากทำธุรกรรม
transaction_time		เวลาของธุรกรรม (เช่น เวลาในการรับเข้า/จ่ายออก)
created_at		เวลาที่สร้างธุรกรรม
created_by		สมาชิกที่สร้างธุรกรรม
created_by.id		รหัสเฉพาะของสมาชิก
created_by.name		ชื่อสมาชิก
created_by.deleted		ระบุว่าสมาชิกถูกลบหรือไม่
count_of_items		จำนวนรายการสินค้า
total_quantity		ปริมาณรวมของการเปลี่ยนแปลงสต็อก
url		ที่อยู่ URL สำหรับดูหน้ารายละเอียดธุรกรรม
memo		หมายเหตุที่เกี่ยวข้องกับธุรกรรม
revision		หมายเลขเวอร์ชันปัจจุบันของธุรกรรม เริ่มจาก 1

ตัวอย่างเพย์โหลดเว็บฮุก – แก้ไขแล้ว รับเข้า ธุรกรรม

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

ตัวอย่างเพย์โหลดเว็บฮุก – แก้ไขแล้ว ย้ายสต็อก ธุรกรรม

{
  "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	รหัสเฉพาะของธุรกรรม
revision	หมายเลขเวอร์ชันปัจจุบันของธุรกรรม เริ่มจาก 1

ตัวอย่างเพย์โหลดเว็บฮุก – ธุรกรรมที่ถูกลบ

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

item/new

ส่งเมื่อมีการเพิ่มรายการสินค้าใหม่ลงในสินค้าคงคลังของทีม

หมายเหตุ: เหตุการณ์นี้ ไม่ ถูกเรียกเมื่อใช้ฟีเจอร์ เพิ่มตัวแปรสินค้าที่ หรือนำเข้าสินค้าผ่าน นำเข้า Excel.

ฟิลด์	คำอธิบาย
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": "หมวดหมู่",
      "type": "text",
      "value": "รองพื้น"
    },
    {
      "id": 459264,
      "name": "วันหมดอายุ",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "สต็อกความปลอดภัย",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

ส่งเมื่อมีการแก้ไขรายการสินค้าที่มีอยู่แล้ว

หมายเหตุ: เหตุการณ์นี้ ไม่ ถูกเรียก fหรือสำหรับการแก้ไขจำนวนมากที่ทำผ่าน ศูนย์ข้อมูล > สินค้า หรือผ่านฟังก์ชัน นำเข้า Excel นี้

ฟิลด์	คำอธิบาย
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": "หมวดหมู่",
      "type": "text",
      "value": "รองพื้น"
    },
    {
      "id": 459264,
      "name": "วันหมดอายุ",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "สต็อกความปลอดภัย",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

ส่งเมื่อมีการลบรายการสินค้าออกจากสินค้าคงคลังของทีม

หมายเหตุ: เหตุการณ์นี้ ไม่ ถูกเรียกสำหรับการลบจำนวนมากที่ทำผ่าน ศูนย์ข้อมูล > สินค้า.

ฟิลด์	คำอธิบาย
id	รหัสสินค้า

ตัวอย่างเพย์โหลด – สินค้าที่ถูกลบ

{
  "id": 26122826
}