मुख्य सामग्री पर जाएं
सीखेंगाइडवेबहुक के साथ एजेंट भुगतान संभालें
गाइड

वेबहुक पैटर्न जिनके बारे में डेवलपर्स सबसे अधिक पूछते हैं।

15 मिनट
संक्षिप्त उत्तर

एक विश्वसनीय वेबहुक हैंडलर चार चीजें क्रम में करता है: कच्चे शरीर के खिलाफ हस्ताक्षर की पुष्टि करें (Node में webhooks.verify, अन्यत्र प्रलेखित HMAC), घटना आईडी द्वारा डेडुप्लिकेट करें, काम को एक बैकग्राउंड कतार में डालें, और 200 लौटाएं। लंबी अवधि का काम कार्यकर्ता में होता है, कतार परत में पुनः प्रयास और अद्वितीयता के साथ। क्योंकि कोई विफलता घटना नहीं है, एक निर्धारित स्वीप उन नौकरियों को समय सीमा समाप्त कर देता है जो भुगतान की प्रतीक्षा कर रही हैं और उन्हें समायोजित करता है।

पूर्वापेक्षाएँ

शुरू करने से पहले।

  • एक कार्यशील एजेंट प्रोफ़ाइल और आपके डैशबोर्ड से साइनिंग सीक्रेट (सेटिंग्स - वेबहुक)।
  • एक वेब फ्रेमवर्क जिसमें कच्चे शरीर तक पहुंच है - express.raw के साथ एक्सप्रेस, FastAPI, Flask, आदि। ऑटो-पार्सिंग JSON मिडलवेयर सिग्नेचर सत्यापन को तोड़ता है।
  • एक नौकरी कतार: BullMQ (Node) या Celery/arq (Python)। वेबहुक तेजी से 200 लौटाता है और कतार धीमा काम करती है।
  • एक डेटाबेस जिसमें एक अपसर्ट प्राइमिटिव है (Postgres काम करता है; Redis SET NX भी अल्पकालिक डेडुप्लिकेशन के लिए काम करता है)।
  • एक सार्वजनिक HTTPS एंडपॉइंट - विकास में, ngrok या एक डिप्लॉय पूर्वावलोकन। प्रेषक निजी URL पर डिलीवरी नहीं करेगा।
चरण 1 में 4

हस्ताक्षर सत्यापित करें।

The signature is HMAC-SHA256 over {t}.{rawBody} with your webhook secret, hex-encoded, in the X-Blockchain0x-Signature header (t=<unix>,v1=<hex>), inside a 5-minute replay window. In Node, webhooks.verify from @blockchain0x/node does it and returns a discriminated union; in other languages compute the same HMAC and compare in constant time. Raw-body access matters: if the bytes you sign locally differ from the bytes that arrived, it fails.

TypeScript
import express from "express";
import { webhooks } from "@blockchain0x/node";

const app = express();
// Raw body so the HMAC matches the exact bytes on the wire.
app.use(express.raw({ type: "application/json" }));

app.post("/webhooks/payment", (req, res) => {
  const result = webhooks.verify({
    headers: req.headers,
    rawBody: req.body, // Buffer, raw bytes
    secret: process.env.BLOCKCHAIN0X_WEBHOOK_SECRET!,
  });
  // Discriminated union: branch on ok, no try/catch.
  if (!result.ok) return res.status(400).json({ code: result.code });
  // result.eventType / result.eventId are now set.
  handleEvent(result);
  res.status(200).send("ok");
});
Python
import hmac, hashlib, os, time
from flask import request

SECRET = os.environ["BLOCKCHAIN0X_WEBHOOK_SECRET"].encode()

# In Node, webhooks.verify does this. In Python, verify by hand against the
# documented algorithm: HMAC-SHA256 over "{t}.{rawBody}", 300s replay window.
def verify_signature(raw_body: bytes) -> bool:
    sig = request.headers.get("X-Blockchain0x-Signature", "")
    ts = request.headers.get("X-Blockchain0x-Timestamp", "")
    parts = dict(p.split("=", 1) for p in sig.split(",") if "=" in p)
    t, v1 = parts.get("t", ts), parts.get("v1", sig)
    want = hmac.new(SECRET, t.encode() + b"." + raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(want, v1) and abs(time.time() - int(t)) <= 300
चरण 2 में 4

हैंडलर को आइडेम्पोटेंट बनाएं।

Webhooks retry on any non-2xx response, and the same event will arrive multiple times under load even when nothing has gone wrong. Dedupe on the event's id using a database upsert. If the row already exists, skip; if it does not, insert and proceed. Postgres makes this a single statement.

TypeScript
// Pseudocode for a Postgres-backed dedupe table. Replace with your DB of choice.
async function processEventOnce(eventId: string, body: object) {
  // INSERT ... ON CONFLICT DO NOTHING returns rowCount === 0 on duplicate.
  const inserted = await db.query(
    "INSERT INTO webhook_events(id) VALUES ($1) ON CONFLICT DO NOTHING",
    [eventId],
  );
  if (inserted.rowCount === 0) return;          // Already processed.
  await handleEvent(body);
}
Python
async def process_event_once(event_id: str, body: dict):
    # INSERT ... ON CONFLICT DO NOTHING returns 0 rows on duplicate.
    inserted = await db.execute(
        "INSERT INTO webhook_events (id) VALUES ($1) ON CONFLICT DO NOTHING",
        event_id,
    )
    if inserted == "INSERT 0 0":   # asyncpg-style status
        return                     # Already processed.
    await handle_event(body)
चरण 3 में 4

एनक्यू करें और 200 तेजी से लौटाएं।

वेबहुक अंत बिंदु को एक सेकंड के भीतर प्रतिक्रिया देनी चाहिए। कोई भी धीमा समय समाप्ति और पुनः प्रयासों को आमंत्रित करता है। पैटर्न है: सत्यापित करें, एंकी करें, प्रतिक्रिया दें। कतार वास्तविक डिलीवरी को एक कार्यकर्ता में पुनः प्रयासों, गुणात्मक बैकऑफ, और अपनी स्वयं की आइडेम्पोटेंसी के साथ चलाती है। BullMQ और Celery दोनों प्रति-कार्य ID का समर्थन करते हैं, जो समान घटना के पुनः एंकीकरण को रोकता है।

TypeScript (BullMQ)
// Express handler: verify, enqueue, return 200 fast.
import { Queue } from "bullmq";
import { webhooks } from "@blockchain0x/node";

const paymentQueue = new Queue("payments");

app.post(
  "/webhooks/payment",
  express.raw({ type: "application/json" }),
  async (req, res) => {
    const result = webhooks.verify({
      headers: req.headers,
      rawBody: req.body,
      secret: process.env.BLOCKCHAIN0X_WEBHOOK_SECRET!,
    });
    if (!result.ok) return res.status(400).json({ code: result.code });
    await paymentQueue.add(result.eventType, { raw: req.body.toString() }, {
      jobId: result.eventId,            // Idempotency key.
      removeOnComplete: true,
      attempts: 5,
      backoff: { type: "exponential", delay: 1000 },
    });
    res.status(200).send("ok");
  },
);

// Worker file:
import { Worker } from "bullmq";
new Worker("payments", async (job) => {
  await handleEvent(job.data);
});
Python (Celery)
# Flask handler enqueues to Celery (or arq) and returns 200 quickly.
from celery import Celery
from flask import request

celery = Celery("payments", broker=os.environ["REDIS_URL"])

@celery.task(bind=True, max_retries=5)
def handle_payment_event(self, event_type, raw):
    try:
        process_event_once(event_type, raw)
    except Exception as exc:
        raise self.retry(exc=exc, countdown=2 ** self.request.retries)

@app.post("/webhooks/payment")
def webhook():
    raw = request.get_data()
    if not verify_signature(raw):
        abort(401)
    event_id = request.headers.get("X-Blockchain0x-Event-Id", "")
    event_type = request.headers.get("X-Blockchain0x-Event-Type", "")
    handle_payment_event.apply_async(args=[event_type, raw.decode()], task_id=event_id)
    return "ok", 200

arq Python पक्ष पर उसी आकार का पालन करता है - कार्य को एक निश्चित कार्य आईडी के साथ पंजीकृत करें और कतार को पुनः प्रयास करने दें। मुख्य बाधा यह है कि एनक्यू स्वयं तेज होना चाहिए (Redis के लिए एकल राउंड ट्रिप); दूरस्थ कॉल पर कभी भी वेबहुक को ब्लॉक न करें।

चरण 4 में 4

एक भुगतान को संभालें जो कभी नहीं पहुँचता।

कोई विफलता वेबहुक नहीं है - यदि एक खरीदार छोड़ देता है, तो कोई घटना नहीं आती है, और एजेंट 'awaiting_payment' में अटका रहता है। इसलिए इसे स्वयं पहचानें: उन कार्यों पर एक अनुसूचित स्वीप चलाएँ जिन्होंने बहुत लंबा इंतजार किया है, यदि यह वास्तव में निपट गया है तो transactions.get के साथ श्रृंखला के खिलाफ समेटें, फिर रखे गए संसाधनों को मुक्त करें, कार्य को एक टर्मिनल अनपेक्षित स्थिति में ले जाएँ, और (यदि उपयुक्त हो) परिणाम को उपयोगकर्ता के सामने लाएँ।

TypeScript
async function sweepStaleAwaitingPayment() {
  for (const job of await findJobsAwaitingPaymentOlderThan("1h")) {
    // Reconcile against the chain before giving up.
    const tx = job.txHash ? await client.transactions.get(job.txHash) : null;
    if (tx) { markJobPaid(job.id); continue; }   // It actually settled.

    // 1. Release any held resources tied to the job.
    releaseHeldResources(job.id);
    // 2. Move it out of 'awaiting_payment' into a terminal 'unpaid' state.
    markJobUnpaid(job.id);
    // 3. (Optional) Notify the user, with a fresh payment link.
    notifyUser(job.userId, { template: "agent_payment_unpaid", jobId: job.id });
  }
}
Python
# Run on a schedule - there is no failure webhook to wait for.
def sweep_stale_awaiting_payment():
    for job in find_jobs_awaiting_payment_older_than("1h"):
        tx = client.transactions.get(job["tx_hash"]) if job.get("tx_hash") else None
        if tx:
            mark_job_paid(job["id"])   # It actually settled.
            continue

        release_held_resources(job["id"])
        mark_job_unpaid(job["id"])
        notify_user(job["user_id"], template="agent_payment_unpaid", job_id=job["id"])
सामान्य pitfalls

पांच गलतियाँ जो घटनाओं को छोड़ती या डुप्लिकेट करती हैं।

हस्ताक्षर की पुष्टि करने से पहले शरीर को पार्स करना

HMAC को उन कच्चे बाइट्स पर गणना की जानी चाहिए जिन्हें प्रेषक ने हस्ताक्षरित किया। यदि आपका ढांचा आपके हैंडलर के चलने से पहले JSON को स्वचालित रूप से पार्स करता है, तो आप जो बाइट्स स्थानीय रूप से हस्ताक्षरित करते हैं वे प्रेषक द्वारा हस्ताक्षरित बाइट्स से मेल नहीं खाएंगे (विभिन्न व्हाइटस्पेस, कुंजी क्रम, एन्कोडिंग) और हर हस्ताक्षर अमान्य दिखाई देगा। रूट को कच्चा शरीर प्राप्त करने के लिए कॉन्फ़िगर करें (Express: express.raw, Flask: request.get_data), पहले सत्यापित करें, फिर पार्स करें।

वेबहुक हैंडलर के अंदर असली काम करना

Webhooks में आक्रामक पुनः प्रयास नीतियाँ होती हैं। यदि आपका हैंडलर कार्य को वितरित करने में 30 सेकंड लेता है, तो प्रेषक का टाइमआउट सक्रिय होता है और वेबहुक फिर से भेजा जाता है - अब आपके पास उसी भुगतान के लिए दो डिलीवरी उड़ान में हैं। हमेशा: सत्यापित करें, कतार में डालें, 2xx लौटाएँ। वास्तविक कार्य एक बैकग्राउंड वर्कर में चलता है जिसे जितना समय चाहिए उतना ले सकता है।

व्यापार लॉजिक को संप्रेषित करने के लिए HTTP स्थिति का उपयोग करना

यदि आपका हैंडलर 4xx लौटाता है जब उपयोगकर्ता अब आपके सिस्टम में मौजूद नहीं है, तो प्रेषक इसे 'अमान्य अनुरोध' के रूप में मानता है और पुनः प्रयास करना बंद कर देता है। यदि यह उसी स्थिति के लिए 5xx लौटाता है, तो प्रेषक हमेशा के लिए पुनः प्रयास करता है और आपकी कतार भर जाती है। जब आप सुरक्षित रूप से घटना को बनाए रखते हैं (या इसे डुप के रूप में पहचानते हैं) तो 200 लौटाएं; व्यावसायिक निर्णय व्यक्त करने के लिए कतार लॉजिक का उपयोग करें, HTTP स्थिति नहीं।

इवेंट आईडी के बजाय पेलोड हैश पर आइडेम्पोटेंसी

एक ही एजेंट के बारे में दो अलग-अलग घटनाएँ (एक payment.received और एक बाद में payment.sent) के अलग-अलग शरीर होते हैं और वैध रूप से अलग-अलग प्रसंस्करण की आवश्यकता होती है। यदि आपका डेडुप बॉडी हैश पर है तो आप उनमें से एक को छोड़ सकते हैं। X-Blockchain0x-Event-Id (प्रत्येक डिलीवरी के लिए अद्वितीय) पर डेडुप करें, और घटना प्रकार को यह निर्धारित करने दें कि आपका हैंडलर क्या करता है।

एक अलग पुष्टि घटना की अपेक्षा कर रहे हैं

शिप किए गए इवेंट्स हैं payment.received, payment.sent, wallet.deployed, और webhook.test - कोई अलग पुष्टि इवेंट नहीं है। payment.received तब सक्रिय होता है जब हस्तांतरण एक ब्लॉक में होता है, जो आपके लिए अधिकांश कार्य का संकेत है। कुछ महंगा या अपरिवर्तनीय के लिए, transactions.get को पोल करें और अपनी स्वयं की पुष्टि सीमा लागू करें; किसी ऐसे इवेंट का इंतजार न करें जो मौजूद नहीं है।

अगले कदम

जैसे ही वेबहुक बुलेटप्रूफ होते हैं।

वेबहुक कठिन हिस्सा हैं। उपरोक्त चार पैटर्न के साथ, शेष कार्य मुख्य रूप से परिचालन है: एक परीक्षण वातावरण जो विफलता पथों का परीक्षण करता है, खर्च नियंत्रण ताकि एक अपस्ट्रीम एजेंट आपके हैंडलर को बाढ़ न करे, और एक अंतिम सुरक्षा समीक्षा।

पूर्ण संदर्भ docs.blockchain0x.com पर है। वेबहुक शब्दावली: भुगतान जनादेश. उत्पाद सतह: भुगतान API

अंतिम समीक्षा: 2026-05-15। CC BY 4.0 के तहत प्रकाशित।

वेबहुक जिन पर आप लोड के तहत भरोसा कर सकते हैं।

हस्ताक्षरित, पुनः प्रयास किया गया, आइडेम्पोटेंट। शुरू करने के लिए मुफ्त।