वेबहुक

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

---

पंजीकरण

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

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

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

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

• यदि आपका सर्वर जवाब देता है कोई भी non-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 और order-tolerant लॉजिक लागू करें।

इवेंट टॉपिक्स

यदि आपको अतिरिक्त इवेंट टॉपिक्स के लिए सहायता चाहिए, तो कृपया संपर्क करें सहायता.

txs/new

जब इन्वेंटरी लेनदेन होता है (स्टॉक इन / स्टॉक आउट / स्टॉक समायोजित करें / स्टॉक स्थानांतरित करें), तब ट्रिगर होता है।

नोट: यह इवेंट नहीं बल्क एडिट या इम्पोर्ट के माध्यम से बनाए गए समायोजनों के लिए ट्रिगर नहीं होता (उदा., Excel के माध्यम से आइटम जोड़ते या अपडेट करते समय)।

आवश्यकआवश्यकता

फ़ील्ड	आवश्यक	विवरण
id		लेनदेन की अद्वितीय ID
type		लेनदेन प्रकार\n(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": "गोदाम 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": "गोदाम 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		लेनदेन प्रकार\n(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": "गोदाम 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": "गोदाम 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
संशोधन	लेनदेन का वर्तमान संस्करण नंबर, 1 से शुरू

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

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

item/new

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

नोट: यह इवेंट नहीं तब ट्रिगर होता है जब उपयोग किया जाता है Add Item Variants सुविधा या आइटमों को इसके माध्यम से आयात करने पर Import Excel.

आवश्यकता

फ़ील्ड	विवरण
id	आइटम 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": "श्रेणी",
      "type": "text",
      "value": "फ़ाउंडेशन"
    },
    {
      "id": 459264,
      "name": "समाप्ति तिथि",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "सुरक्षा स्टॉक",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

जब कोई मौजूदा आइटम संपादित किया जाता है, तब भेजा जाता है।

नोट: यह इवेंट नहीं ट्रिगर किया जाता है fया इसके माध्यम से किए गए बल्क संपादनों के लिए डेटा सेंटर > आइटम या इसके माध्यम से Import Excel फ़ंक्शन।

आवश्यकता

फ़ील्ड	विवरण
id	आइटम 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": "श्रेणी",
      "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
}