मुख्य सामग्रीकडे जा
शिकामार्गदर्शकवेबहुकसह एजंट पेमेंट्स हाताळा
मार्गदर्शक

डेव्हलपर्स सर्वात जास्त विचारतात त्या वेबहुक पॅटर्न.

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 पायथन बाजूवर समान आकाराचे अनुसरण करते - एक निश्चित कार्य आयडीसह कार्य नोंदणी करा आणि क्यूला पुनर्प्रयत्न हाताळू द्या. मुख्य बंधन म्हणजे एनक्यू स्वतः जलद असावा (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"])
सामान्य अडथळे

पाच चुका ज्या इव्हेंट्स ड्रॉप किंवा डुप्लिकेट करतात.

स्वाक्षरीची पडताळणी करण्यापूर्वी शरीराचे विश्लेषण करणे

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

वेबहुक हँडलरच्या आत खरे काम करणे

Webhooks मध्ये आक्रमक पुन्हा प्रयत्न धोरणे आहेत. जर तुमचा हँडलर काम वितरित करण्यासाठी 30 सेकंद घेत असेल, तर पाठवणाऱ्याचा टाइमआउट कार्यान्वित होतो आणि वेबहुक पुन्हा पाठवला जातो - आता तुमच्याकडे एकाच पेमेंटसाठी दोन वितरण आहेत. नेहमी: सत्यापित करा, एनक्यू करा, 2xx परत करा. वास्तविक काम एक बॅकग्राउंड वर्करमध्ये चालते ज्याला आवश्यक असल्यास जितका वेळ लागेल.

व्यवसाय तत्त्वज्ञान संवाद साधण्यासाठी HTTP स्थितीचा वापर

जर तुमचा हँडलर 4xx परत करत असेल जेव्हा वापरकर्ता तुमच्या प्रणालीमध्ये अस्तित्वात नाही, तर प्रेषक ते 'अवैध विनंती' म्हणून मानतो आणि पुन्हा प्रयत्न करणे थांबवतो. जर तो समान स्थितीसाठी 5xx परत करत असेल, तर प्रेषक सदैव पुन्हा प्रयत्न करतो आणि तुमची रांगा भरली जाते. तुम्ही सुरक्षितपणे इव्हेंट जतन केल्यावर (किंवा त्याला डुप म्हणून ओळखल्यावर) 200 परत करा; व्यवसाय निर्णय व्यक्त करण्यासाठी HTTP स्थिती नाही, तर रांगेची तत्त्वे वापरा.

इव्हेंट ID च्या ऐवजी पेलोड हॅशवर आयडेम्पोटेन्सी

त्याच एजंटाबद्दल दोन भिन्न इव्हेंट (एक payment.received आणि नंतरचा payment.sent) भिन्न शरीर आहेत आणि वैधपणे वेगवेगळ्या प्रक्रियेची आवश्यकता आहे. जर तुमचा डेडुपlication शरीर हॅशवर असेल तर तुम्ही त्यापैकी एक गाळू शकता. X-Blockchain0x-Event-Id (प्रत्येक वितरणासाठी अद्वितीय) वर डेडुपlication करा, आणि इव्हेंट प्रकार तुमच्या हँडलरने काय केले पाहिजे हे चालवू द्या.

एक स्वतंत्र पुष्टीकरण इव्हेंटची अपेक्षा आहे

शिप केलेले इव्हेंट्स आहेत payment.received, payment.sent, wallet.deployed, आणि webhook.test - कोणतीही वेगळी पुष्टीकरण इव्हेंट नाही. हस्तांतरण ब्लॉकमध्ये असताना payment.received कार्यान्वित होते, जे तुमच्यासाठी बहुतेक कामाचे सिग्नल आहे. काही महाग किंवा अपरिवर्तनीय गोष्टीसाठी, transactions.get ला पोल करा आणि तुमचा स्वतःचा पुष्टीकरण थRESHOLD लागू करा; अस्तित्वात नसलेल्या इव्हेंटची वाट पाहू नका.

पुढील पायऱ्या

एकदा वेबहुक्स बुलेटप्रूफ झाले की.

वेबहुक्स कठीण भाग आहेत. वरील चार पॅटर्न्स कार्यरत असताना, उर्वरित काम मुख्यतः कार्यात्मक आहे: एक चाचणी वातावरण जे अपयशाच्या मार्गांचा अभ्यास करते, खर्च नियंत्रण जेणेकरून एक अपस्ट्रीम एजंट तुमच्या हँडलरवर ओव्हरफ्लोड होणार नाही, आणि अंतिम सुरक्षा पुनरावलोकन.

पूर्ण संदर्भ docs.blockchain0x.com येथे आहे. वेबहुक शब्दकोश: पेमेंट मंडेट. उत्पादन पृष्ठ: पेमेंट API.

शेवटचा पुनरावलोकन: 2026-05-15. CC BY 4.0 अंतर्गत प्रकाशित.

ताणाखाली तुम्ही विश्वास ठेवू शकता अशा वेबहुक्स.

स्वाक्षरी केली, पुन्हा प्रयत्न केला, आयडेम्पोटेंट. सुरू करण्यासाठी मोफत.