Webhook

Webhooks ऐसी सुविधाएँ हैं जो आपको BoxHero में कुछ घटनाएँ होने पर रीयल-टाइम सूचनाएँ प्राप्त करने देती हैं।

---

पंजीकरण

आप यहाँ एक वेबहुक पंजीकृत कर सकते हैं सेटिंग्स > इंटीग्रेशन्स और API अपने BoxHero टीम में।

डिलीवरी और पुनः प्रयास व्यवहार

जब कोई घटना होती है, BoxHero एक HTTP POST अनुरोध आपके पंजीकृत वेबहुक एंडपॉइंट पर भेजता है। अनुरोध बॉडी में घटना का वर्णन करने वाला JSON पेलोड होता है।

• यदि आपका सर्वर HTTP 200 OKके साथ प्रतिक्रिया देता है, तो घटना को सफलतापूर्वक डिलीवर माना जाता है।

• यदि आपका सर्वर कोई भी गैर-200 स्थिति कोडके लिए, BoxHero इसे एक अस्थायी विफलता मानता है और 3 बार तक डिलीवरी पुनः प्रयास करता है।

वेबहुक पेलोड संरचना

सभी वेबहुक घटनाएँ अनुरोध बॉडी में निम्न 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 क्षेत्र घटना पेलोड में वास्तविक घटना समय को दर्शाता है। घटनाओं को विश्वसनीय रूप से संभालने के लिए अपने वेबहुक हैंडलर में idempotent और क्रम-सहिष्णु लॉजिक लागू करें।

घटना विषय

यदि आपको अतिरिक्त घटना विषयों के लिए समर्थन चाहिए, तो कृपया संपर्क करें सपोर्ट.

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		लेन-देन से संबंधित नोट्स

उदाहरण वेबहुक पेलोड – स्टॉक इन घटना

{
  "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		लेन-देन की अद्वितीय 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		लेन-देन के कारण मात्रा परिवर्तन (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		सदस्य की अद्वितीय ID
created_by.name		सदस्य का नाम
created_by.deleted		क्या सदस्य हटाया गया है
count_of_items		आइटमों की संख्या
total_quantity		इन्वेंटरी परिवर्तन की कुल मात्रा
url		लेन-देन विवरण पृष्ठ देखने के लिए URL पता
memo		लेन-देन से संबंधित नोट्स
संशोधन		लेन-देन का वर्तमान संस्करण नंबर, 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	लेन-देन की अद्वितीय ID
संशोधन	लेन-देन का वर्तमान संस्करण नंबर, 1 से शुरू

उदाहरण वेबहुक पेलोड – हटाया गया लेन-देन

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

item/new

जब टीम की इन्वेंटरी में एक नया आइटम जोड़ा जाता है, तब भेजा जाता है।

नोट: यह घटना नहीं ट्रिगर होती है जब Add Item Variants सुविधा का उपयोग किया जाता है या आइटम्स को Import 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के माध्यम से किए गए बल्क संपादनों डेटा सेंटर > Item या Import 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

जब किसी आइटम को टीम की इन्वेंटरी से हटाया जाता है, तब भेजा जाता है।

नोट: यह घटना नहीं ट्रिगर होती है डेटा सेंटर > Item.

क्षेत्र	विवरण
id	आइटम ID

उदाहरण पेलोड – आइटम हटाया गया

{
  "id": 26122826
}