Webhook

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

---

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

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

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

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

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

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

โครงสร้างเพย์โหลดของ Webhook

อีเวนต์ webhook ทั้งหมดจะถูกส่งด้วยโครงสร้าง 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 ในเพย์โหลดอีเวนต์จะแสดงเวลาที่เกิดอีเวนต์จริง ให้ implement ตรรกะแบบ idempotent และทนต่อการสลับลำดับในตัวจัดการ webhook ของคุณเพื่อจัดการอีเวนต์ได้อย่างเชื่อถือ

หัวข้ออีเวนต์

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

txs/new

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

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

จำเป็นจำเป็นหรือไม่

ฟิลด์	จำเป็น	คำอธิบาย
id		รหัสเฉพาะของธุรกรรม
type		ประเภทของธุรกรรม (in, out, adjust, move)
partner		คู่ค้า
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 สำหรับดูหน้ารายละเอียดธุรกรรม
บันทึก		หมายเหตุที่เกี่ยวข้องกับธุรกรรม

ตัวอย่างเพย์โหลดของ 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		รหัสเฉพาะของธุรกรรม
type		ประเภทของธุรกรรม (in, out, adjust, move)
partner		คู่ค้า
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 สำหรับดูหน้ารายละเอียดธุรกรรม
บันทึก		หมายเหตุที่เกี่ยวข้องกับธุรกรรม
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	รหัสเฉพาะของธุรกรรม
revision	หมายเลขเวอร์ชันปัจจุบันของธุรกรรม เริ่มต้นที่ 1

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

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

item/new

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

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

จำเป็นหรือไม่

ฟิลด์	คำอธิบาย
id	รหัสสินค้า
name	ชื่อสินค้า
sku	SKU
barcode	บาร์โค้ด
photo_url	URL รูปภาพ
cost	ต้นทุน
price	ราคา
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	รหัสสินค้า
name	ชื่อสินค้า
sku	SKU
barcode	บาร์โค้ด
photo_url	URL รูปภาพ
cost	ต้นทุน
price	ราคา
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": 26122826
}