समीक्षा 2026-11-11 · API संस्करण 2026-11-09 · Markdown पढ़ें
ग्राहक वेबहुक
आपके वर्कस्पेस के लिए आउटगोइंग इवेंट डिलीवरी। HTTPS एंडपॉइंट रजिस्टर करें, वन-टाइम साइनिंग सीक्रेट सत्यापित करें, और बाउंडेड रिट्राइ के साथ साइन किए इवेंट प्राप्त करें।
एंडपॉइंट रजिस्टर करें
curl -s -X POST -H "Authorization: Bearer $PUBLISHER_KEY" \
-H "Idempotency-Key: $(uuidgen)" -H "Content-Type: application/json" \
$BASE/webhooks -d '{"url": "https://example.com/hooks/autoposted"}'
- साइनिंग सीक्रेट (
whsec_…) एक बार लौटाया जाता है: पहली सफल क्रिएशन प्रतिक्रिया में। उसे संग्रहीत करें; उसी क्रिएशन का आइडेंपोटेंट रिप्ले एंडपॉइंट बिना सीक्रेट लौटाता है, और उसे दोबारा नहीं दिखाया जा सकता। - गंतव्य HTTPS, सार्वजनिक रूप से रिज़ॉल्व होने वाले और एम्बेडेड क्रेडेंशियल से मुक्त होने चाहिए। प्राइवेट, लूपबैक, लिंक-लोकल (क्लाउड मेटाडेटा सहित), यूनिक-लोकल और मल्टीकास्ट पतों को किए गए रिक्वेस्ट किसी कनेक्शन से पहले अस्वीकार किए जाते हैं, और रीडायरेक्ट कभी फ़ॉलो नहीं किए जाते।
- रजिस्ट्रेशन उस एंडपॉइंट के लिए टार्गेटेड
webhook.verificationइवेंट क्यू करता है, उसकेeventTypesफ़िल्टर से स्वतंत्र। साधारण इवेंट तभी बहते हैं जब आपका एंडपॉइंट सत्यापन का 2xx जवाब दे देता है।
डिलीवरी सत्यापित करना
हर रिक्वेस्ट रखता है:
| हेडर | अर्थ |
|---|---|
x-publisher-event-id | स्थिर इवेंट ID: रिट्राइ और रिप्ले में पहचान योग्य |
x-publisher-event-type | इवेंट प्रकार, जैसे post.published |
x-publisher-timestamp | Unix सेकंड |
x-publisher-signature | t=<ts>,v1=<hex> |
सिग्नेचर आपके साइनिंग सीक्रेट का उपयोग करके ${t}.${event_id}.${raw_body}
पर HMAC-SHA256 है। ±300 सेकंड सहिष्णुता के साथ सत्यापित करें और बाहर के
रिप्लेयर अस्वीकार करें। Node उदाहरण:
import { createHmac, timingSafeEqual } from 'node:crypto';
function verify(secret, headers, rawBody) {
const m = /^t=(\d+),v1=([0-9a-f]{64})$/.exec(headers['x-publisher-signature']);
if (!m) return false;
const [t, v1] = [Number(m[1]), m[2]];
if (Math.abs(Date.now() / 1000 - t) > 300) return false;
const expected = createHmac('sha256', secret)
.update(`${t}.${headers['x-publisher-event-id']}.${rawBody}`)
.digest('hex');
return timingSafeEqual(Buffer.from(expected), Buffer.from(v1));
}
पार्स करने से पहले हमेशा raw रिक्वेस्ट बॉडी के विरुद्ध सत्यापित करें।
इवेंट एनवेलप
{
"id": "0192d0d0-0000-7000-8000-00000000000f",
"type": "post.published",
"createdAt": "2026-11-09T12:00:01Z",
"apiVersion": "2026-11-09",
"data": { "postId": "…", "deliveryId": "…", "accountId": "…" }
}
प्रारंभिक इवेंट कैटलॉग (विस्तारणीय; रजिस्ट्रेशन पर eventTypes फ़िल्टर करता है):
webhook.verification: चैलेंज पेलोड; एंडपॉइंट सक्रिय करने के लिए 2xx जवाब देंpost.published: एक गंतव्य नेटिव रसीद के साथ पुष्टdelivery.failed: एक गंतव्य टर्मिनल रूप से विफलdelivery.requires_action: सहमति/रीकनेक्शन/देर से समीक्षा आवश्यक
एग्रीगेट पोस्ट परिणाम (post.partially_published, post.failed) अभी
जारी नहीं होते; वे यहाँ केवल तब डॉक्यूमेंट किए जाते हैं जब प्रोड्यूसर मौजूद हो, इसलिए
उन पर भरोसा न करें। ऊपर के प्रति-गंतव्य इवेंट सब्सक्राइब करें और पोस्ट की
डिलीवरी परिणामों से बैच स्थिति प्राप्त करें।
रिट्राइ, रिप्ले और अक्षम करना
- प्रयास: तुरंत, फिर +1m, +5m, +30m, +2h, +8h। रिट्राइ वही इवेंट ID और बाइट-पहचान योग्य बॉडी पुनः उपयोग करते हैं ताकि आप सुरक्षित रूप से डीडुप्लिकेट कर सकें।
- 2xx = डिलीवर्ड। 429/5xx/टाइमआउट रिट्राइ होते हैं। अन्य 4xx उस इवेंट के लिए स्थायी रूप से विफल (एंडपॉइंट ठीक करें, फिर रिप्ले करें)।
- 410 Gone एंडपॉइंट अक्षम करता है: उसे कोई और इवेंट क्यू नहीं होता।
- इंटरनल वेबहुक सेवा के माध्यम से ऑपरेटर-अधिकृत रिप्ले इवेंट को उसकी मूल ID के साथ फिर से भेजता है। सक्रिय-लीज़्ड इन-फ़्लाइट प्रयास कभी नहीं खींचा जाता; रिप्ले बताता है कि इवेंट व्यस्त है और शीघ्र फिर प्रयास किया जा सकता है।
ऑपरेशनल नोट्स
- डिलीवरी डायग्नोस्टिक्स केवल सुरक्षित परिणाम कोड संग्रहीत करते हैं: कभी भी आपका सीक्रेट, सिग्नेचर, रिक्वेस्ट हेडर या रिस्पॉन्स बॉडी नहीं। पेलोड अतिरिक्त रूप से सैनिटाइज़ किए जाते हैं: किसी भी चीज़ को क्यू करने से पहले प्रोवाइडर/OAuth सीक्रेट और मीडिया प्रीसाइन URL हटा दिए जाते हैं।
- एंडपॉइंट वर्कस्पेस-स्कोप्ड हैं: दूसरे वर्कस्पेस के एंडपॉइंट UUID का होना कुछ नहीं करता।
- स्वीकृत इवेंट घटना प्रति डिलीवरी कम-से-कम-एक-बार होती है;
x-publisher-event-idपर डीडुप्लिकेट करें।
डेवलपर टूल उपलब्धता
Developers पेज वर्कस्पेस API कियाँ और वेबहुक एंडपॉइंट साइनिंग-सीक्रेट एन्क्रिप्शन कॉन्फ़िगरेशन से स्वतंत्र रूप से सूचीबद्ध करता है। वेबहुक बनाने के लिए मान्य सर्वर एन्क्रिप्शन कॉन्फ़िगरेशन चाहिए; कॉन्फ़िगरेशन चेतावनी सुलझाने के लिए डिप्लॉयमेंट ऑपरेटर से कहें। API-की प्रबंधन उपलब्ध रहता है। मौजूदा साइनिंग सीक्रेट कभी दोबारा नहीं दिखाए जाते।