सेटअप

Unico IDCloud पर एक webhook configure करने के लिए, अपना endpoint, authentication method, और retry policy प्रदान करें। Configuration Unico टीम द्वारा की जाती है — webhook पंजीकृत या update करने के लिए अपनी CS / Onboarding टीम से संपर्क करें।

आवश्यक जानकारी

Field	विवरण
Notification URL	Endpoint जिसे Unico event notifications deliver करने के लिए call करेगा। HTTPS के माध्यम से पहुँचने योग्य होना चाहिए।
Authentication type	Unico आपके endpoint के विरुद्ध कैसे authenticate करता है। नीचे विकल्प देखें।
Retry settings	अधिकतम attempts की संख्या और attempts के बीच अंतराल (exponential backoff लागू किया जाता है)।
Concurrency limit	अधिकतम simultaneous in-flight deliveries की संख्या (अधिकतम: 500)।
Timeout	Endpoint की response के लिए अधिकतम प्रतीक्षा समय, सेकंड में।
Status to notify	Process states का वह समूह जो एक notification trigger करते हैं। वर्तमान में PROCESS_STATE_FINISHED पर fixed है; इस समय configurable नहीं है।

Authentication methods

OAuth2

प्रदान करें:

• Webhook endpoint
• OAuth2 provider URL
• OAuth2 provider ClientId
• OAuth2 provider Secret

Unico client credentials का उपयोग करके provider URL से access token का अनुरोध करेगा और इसे आपके endpoint पर Bearer token के रूप में forward करेगा।

Basic Authorization

user:pass format में credentials प्रदान करें। Unico उन्हें Base64 में encode करता है और प्रत्येक webhook call पर Authorization: Basic <encoded> header में भेजता है।

API Key

दो formats समर्थित हैं। String को पहले colon पर split किया जाता है:

• header:value — एक custom header name set करता है। उदाहरण:
  • X-API-Key:abc123 → X-API-Key: abc123
  • Authorization:Bearer abc123 → Authorization: Bearer abc123
• केवल value (बिना colon के) — value को Authorization header के रूप में बिना किसी scheme prefix के भेजा जाता है। उदाहरण: abc123 → Authorization: abc123।

Bearer scheme की आवश्यकता होने पर header:value format का उपयोग करें (जैसे, Authorization:Bearer <token>); value-only format raw value को बिना prefix के भेजता है।

कोई authentication नहीं

कोई credentials नहीं भेजे जाते। केवल development environments के लिए अनुशंसित — production endpoints को हमेशा authentication की आवश्यकता होनी चाहिए।

Process states जो notifications trigger करते हैं

वर्तमान में, Unico एक notification भेजता है जब भी कोई process transition करता है:

State	विवरण
PROCESS_STATE_FINISHED	Process समाप्त — terminal state, परिणाम चाहे जो भी हो।

States विकसित हो सकते हैं

Platform द्वारा notify किए जाने वाले states का set भविष्य में बदल सकता है। जिन states पर आपका endpoint react करता है उन्हें configurable बनाएं, ताकि नया state जोड़ने के लिए आपकी service को फिर से deploy न करना पड़े।

Request format

Webhook deliveries आपके endpoint पर POST requests हैं। Body में process identifier और current state शामिल हैं। सभी fields अनिवार्य हैं।

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "lastEvent": "EVENT_TYPE_PROCESS_CREATED",
  "lastEventDescription": "Process created"
}

पूर्ण payload schema और lastEvent values की सूची के लिए, Event types देखें।

Expected response

आपका endpoint synchronously respond करना होगा:

• सफलता: 200–299 range में कोई भी HTTP status।
• विफलता: कोई अन्य status। Unico configured अधिकतम attempts तक या 2xx प्राप्त होने तक exponential backoff के साथ retry करेगा।

जल्दी respond करें

Webhook को जल्दी acknowledge करें (अपने configured timeout के भीतर) और अपनी तरफ asynchronously payload process करें। Webhook handler के अंदर long-running processing timeouts और अनावश्यक retries की संभावना बढ़ाती है।

Idempotency और retry handling मार्गदर्शन के लिए, Security देखें।