> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.boxhero.io/docs/documentation/hi/integrations/webhook.md).
# वेबहुक
***
## पंजीकरण
आप यहाँ एक वेबहुक पंजीकृत कर सकते हैं **`सेटिंग्स`** **>** **`इंटीग्रेशन और API`** अपनी BoxHero टीम में।
## डिलीवरी और पुनः प्रयास व्यवहार
जब कोई इवेंट होता है, BoxHero एक HTTP `POST` अनुरोध आपके पंजीकृत वेबहुक एंडपॉइंट पर भेजता है। अनुरोध बॉडी में इवेंट का वर्णन करने वाला JSON पेलोड होता है।
* यदि आपका सर्वर जवाब देता है **HTTP 200 OK**तो इवेंट को सफलतापूर्वक डिलीवर माना जाता है।
* यदि आपका सर्वर जवाब देता है **कोई भी non-200 स्टेटस कोड**तो BoxHero इसे अस्थायी विफलता मानता है और 3 बार तक डिलीवरी पुनः प्रयास करता है।
## वेबहुक पेलोड संरचना
सभी वेबहुक इवेंट अनुरोध बॉडी में निम्न JSON संरचना के साथ डिलीवर किए जाते हैं:
```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 लॉजिक लागू करें।
## इवेंट टॉपिक्स
{% hint style="info" %}
यदि आपको अतिरिक्त इवेंट टॉपिक्स के लिए सहायता चाहिए, तो कृपया संपर्क करें [सहायता](/docs/documentation/hi/resources/contact.md).
{% endhint %}
### `txs/new`
जब इन्वेंटरी लेनदेन होता है (स्टॉक इन / स्टॉक आउट / स्टॉक समायोजित करें / स्टॉक स्थानांतरित करें), तब ट्रिगर होता है।
{% hint style="warning" %}
**नोट:** यह इवेंट *नहीं* बल्क एडिट या इम्पोर्ट के माध्यम से बनाए गए समायोजनों के लिए ट्रिगर नहीं होता (उदा., Excel के माध्यम से आइटम जोड़ते या अपडेट करते समय)।
{% endhint %}
फ़ील्ड
आवश्यक
विवरण
आवश्यकता
विवरण
टीम मोड
id
true
लेनदेन की अद्वितीय ID
true
हिस्ट्री की अद्वितीय ID
संपूर्ण
type
true
लेनदेन प्रकार\n(in, out, adjust, move)
true
हिस्ट्री का प्रकार।
स्टॉक इन : in
स्टॉक आउट : out
समायोजन : adjust
स्थानांतरण : move
संपूर्ण
partner
false
साझेदार
false
partner.id
false
साझेदार की अद्वितीय ID
false
partner.name
false
साझेदार का नाम
false
partner.deleted
false
क्या साझेदार हटाया गया है
false
from_location
false
स्रोत स्थान
false
from_location.id
false
स्रोत स्थान की अद्वितीय ID
false
from_location.name
false
स्रोत स्थान का नाम
false
from_location.deleted
false
क्या स्रोत स्थान हटाया गया है
false
to_location
true
गंतव्य स्थान
false
to_location.id
true
गंतव्य स्थान की अद्वितीय ID
false
to_location.name
true
गंतव्य स्थान का नाम
false
to_location.deleted
true
क्या गंतव्य स्थान हटाया गया है
false
items
true
लेनदेन में पंक्ति आइटम
true
हिस्ट्री बनाने वाले उत्पाद-वार आइटम
सभी मोड
items.id
true
आइटम की अद्वितीय ID
true
उत्पाद की अद्वितीय ID
सभी मोड
items.name
true
आइटम का नाम
true
उत्पाद का नाम
सभी मोड
items.quantity
true
स्टॉक इन/आउट/समायोजन/स्थानांतरण के कारण इन्वेंटरी परिवर्तन
true
संबंधित उत्पाद की स्टॉक इन/आउट/समायोजन/स्थानांतरण मात्रा
### `txs/edit`
जब कोई मौजूदा इन्वेंटरी लेनदेन (स्टॉक इन / स्टॉक आउट / स्टॉक समायोजन / स्टॉक स्थानांतरण) **संपादित किया जाता है**.
फ़ील्ड
आवश्यक
विवरण
आवश्यकता
विवरण
टीम मोड
id
true
लेनदेन की अद्वितीय ID
true
हिस्ट्री की अद्वितीय ID
संपूर्ण
type
true
लेनदेन प्रकार\n(in, out, adjust, move)
true
हिस्ट्री का प्रकार।
स्टॉक इन : in
स्टॉक आउट : out
समायोजन : adjust
स्थानांतरण : move
संपूर्ण
partner
false
साझेदार
false
partner.id
false
साझेदार की अद्वितीय ID
false
partner.name
false
साझेदार का नाम
false
partner.deleted
false
क्या साझेदार हटाया गया है
false
from_location
false
स्रोत स्थान
false
from_location.id
false
स्रोत स्थान की अद्वितीय ID
false
from_location.name
false
स्रोत स्थान का नाम
false
from_location.deleted
false
क्या स्रोत स्थान हटाया गया है
false
to_location
true
गंतव्य स्थान
false
to_location.id
true
गंतव्य स्थान की अद्वितीय ID
false
to_location.name
true
गंतव्य स्थान का नाम
false
to_location.deleted
true
क्या गंतव्य स्थान हटाया गया है
false
items
true
लेनदेन में पंक्ति आइटम
true
हिस्ट्री बनाने वाले उत्पाद-वार आइटम
सभी मोड
items.id
true
आइटम की अद्वितीय ID
true
उत्पाद की अद्वितीय ID
सभी मोड
items.name
true
आइटम का नाम
true
उत्पाद का नाम
सभी मोड
items.quantity
true
लेनदेन के कारण मात्रा परिवर्तन (in/out/adjust/move)
true
संबंधित उत्पाद की स्टॉक इन/आउट/समायोजन/स्थानांतरण मात्रा
सभी मोड
items.deleted
true
क्या आइटम हटाया गया है
true
हटाए गए उत्पाद की स्थिति
items.from_location_new_stock_level
false
लेनदेन के बाद स्रोत स्थान पर स्टॉक स्तर
false
items.to_location_new_stock_level
true
लेनदेन के बाद गंतव्य स्थान पर स्टॉक स्तर
false
transaction_time
true
लेनदेन समय (उदा. स्टॉक इन/आउट समय)
false
created_at
true
वह समय जब लेनदेन बनाया गया था
false
created_by
true
वह सदस्य जिसने लेनदेन बनाया
false
created_by.id
true
सदस्य की अद्वितीय ID
false
created_by.name
true
सदस्य का नाम
false
created_by.deleted
true
क्या सदस्य हटाया गया है
false
count_of_items
true
आइटमों की संख्या
false
total_quantity
true
इन्वेंटरी परिवर्तन की कुल मात्रा
false
url
true
लेनदेन विवरण पृष्ठ देखने के लिए URL पता
false
memo
false
लेनदेन से संबंधित नोट्स
false
संशोधन
true
लेनदेन का वर्तमान संस्करण नंबर, 1 से शुरू
false
#### उदाहरण वेबहुक पेलोड – संपादित लेनदेन `स्टॉक इन` लेनदेन
```json
{
"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"
}
```
#### उदाहरण वेबहुक पेलोड – संपादित लेनदेन `स्टॉक स्थानांतरित करें` लेनदेन
```json
{
"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 से शुरू |
#### उदाहरण वेबहुक पेलोड – हटाया गया लेनदेन
```json
/{
"id": 27036740,
"revision": 2
}
```
### `item/new`
जब टीम की इन्वेंटरी में कोई नया आइटम जोड़ा जाता है, तब भेजा जाता है।
{% hint style="warning" %}
**नोट**: यह इवेंट *नहीं* तब ट्रिगर होता है जब उपयोग किया जाता है **`Add Item Variants`** सुविधा या आइटमों को इसके माध्यम से आयात करने पर **`Import Excel`**.
{% endhint %}
फ़ील्ड
विवरण
आवश्यकता
विवरण
टीम मोड
id
आइटम ID
true
हिस्ट्री की अद्वितीय ID
संपूर्ण
name
आइटम नाम
true
हिस्ट्री का प्रकार।
स्टॉक इन : in
स्टॉक आउट : out
समायोजन : adjust
स्थानांतरण : move
संपूर्ण
sku
SKU
false
barcode
बारकोड
false
photo_url
फ़ोटो URL
false
cost
लागत
false
price
मूल्य
false
attrs
विशेषताएँ
false
#### **उदाहरण पेलोड – आइटम बनाया गया**
```json
{
"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`
जब कोई मौजूदा आइटम संपादित किया जाता है, तब भेजा जाता है।
{% hint style="warning" %}
**नोट**: यह इवेंट *नहीं* ट्रिगर किया जाता है *f*या इसके माध्यम से किए गए बल्क संपादनों के लिए **`डेटा सेंटर`**** > ****`आइटम`** या इसके माध्यम से **`Import Excel`** फ़ंक्शन।
{% endhint %}
फ़ील्ड
विवरण
आवश्यकता
विवरण
टीम मोड
id
आइटम ID
true
हिस्ट्री की अद्वितीय ID
संपूर्ण
name
आइटम नाम
true
हिस्ट्री का प्रकार।
स्टॉक इन : in
स्टॉक आउट : out
समायोजन : adjust
स्थानांतरण : move
संपूर्ण
sku
SKU
false
barcode
बारकोड
false
photo_url
फ़ोटो URL
false
cost
लागत
false
price
मूल्य
false
attrs
विशेषताएँ
false
#### **उदाहरण पेलोड – आइटम अपडेट किया गया**
```json
{
"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`
जब टीम की इन्वेंटरी से कोई आइटम हटाया जाता है, तब भेजा जाता है।
{% hint style="warning" %}
**नोट**: यह इवेंट *नहीं* इसके माध्यम से किए गए बल्क हटाने पर ट्रिगर किया जाता है **`डेटा सेंटर`**** > ****`आइटम`**.
{% endhint %}
फ़ील्ड
विवरण
आवश्यकता
विवरण
टीम मोड
id
आइटम ID
true
हिस्ट्री की अद्वितीय ID
संपूर्ण
#### उदाहरण पेलोड **– आइटम हटाया गया**
```json
{
"id": 26122826
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://www.boxhero.io/docs/documentation/hi/integrations/webhook.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.