मुख्य सामग्री पर जाएं

Webhooks और Events

webhook एक प्रणालीगत अधिसूचना सेवा है जो सिस्टमों के बीच असिंक्रोनस इंटीग्रेशन को सक्षम बनाती है — Unico IDCloud आपके बैकएंड को तब सूचित करता है जब कोई प्रक्रिया स्थिति बदलती है, ताकि आपको अपडेट के लिए polling न करनी पड़े।

यह अनुभाग webhook इंटीग्रेट करने के लिए आवश्यक चार चीजें कवर करता है: endpoint और प्रमाणीकरण सेटअप कैसे करें, Unico जो events भेजता है, fallback रणनीति, और आपके endpoint को लागू करने वाले सुरक्षा और विश्वसनीयता पैटर्न।

Webhooks का उपयोग कब करें

प्रक्रिया पूरी होने की सूचना पाने का अनुशंसित तरीका Webhooks है। ये विशेष रूप से इनके लिए प्रासंगिक हैं:

  • असिंक्रोनस Web & SDK फ्लो — जब Unico की तरफ से POST /client/v1/process का प्रसंस्करण पूरा होने पर सूचित होना हो।
  • लंबे समय तक चलने वाले फ्लो जो कई क्षमताओं को जोड़ते हैं (उदा., दस्तावेज़ विश्लेषण + मैन्युअल समीक्षा)। Webhooks केवल terminal state (PROCESS_STATE_FINISHED) पर fire होते हैं; कोई भी intermediate progress events नहीं भेजे जाते।

Webhooks GetProcess endpoints को पूरक बनाते हैं, लेकिन प्रतिस्थापित नहीं करते। Fallback देखें।

इस अनुभाग में

  • Setup — endpoint पंजीकरण, प्रमाणीकरण विधियाँ (OAuth2, Basic, API Key), retry सेटिंग।
  • Event प्रकार — Unico जो events भेजता है और पेलोड संरचना।
  • सुरक्षा — idempotency, concurrency limit और error rate।
  • Fallback — webhook अनुपलब्ध होने पर प्रक्रिया परिणाम कैसे प्राप्त करें।