Webhook क्या है?
एक Webhook आपको सूचित करने की अनुमति देता है जब कुछ सिस्टम actions आपके द्वारा प्रदान किए गए URL पर एक कॉल के माध्यम से होते हैं। Webhooks को “URL Callbacks” या “HTTP push calls” के रूप में भी जाना जाता है। आपके URL को SSL का उपयोग करना चाहिए और HTTPS से शुरू होना चाहिए।Webhook Actions
webhooks के लिए उपलब्ध actions देखें।
Ayrshare Webhooks को समझना
Webhooks को विशिष्ट action द्वारा वर्गीकृत किया जाता है और Primary Profile या User Profile स्तर पर रजिस्टर किया जाता है। Primary या User Profiles के लिए कोई भी अपडेट पहले User Profile के लिए रजिस्टर किए गए Webhook पर भेजा जाता है। यदि User Profile के पास एक रजिस्टर किया गया Webhook नहीं है, तो अपडेट Primary Profile के रजिस्टर किए गए Webhook पर भेजा जाएगा। उदाहरण के लिए:- यदि एक User Profile के पास एक रजिस्टर किया गया Social Action Webhook है और TikTok को unlink करता है, तो User Profile के लिए रजिस्टर किया गया Social Action Webhook URL कॉल किया जाएगा। Primary Profile webhook कॉल नहीं किया जाएगा।
- यदि एक User Profile TikTok को unlink करता है और उसके पास एक रजिस्टर किया गया Social Action Webhook नहीं है, लेकिन Primary Profile के पास एक रजिस्टर किया गया Webhook है, तो Primary Profile के लिए रजिस्टर किया गया Social Action Webhook URL कॉल किया जाएगा।
एक Webhook रजिस्टर करें
POST/hook/webhook endpoint को एक endpoint URL और action प्रकार प्रदान करके एक Webhook रजिस्टर करें। जब action होता है तो प्रदान किए गए URL पर एक HTTP POST message भेजा जाएगा।
उदाहरण के लिए, scheduled पोस्ट की स्थिति की सूचना पाने के लिए एक URL रजिस्टर करें।
Webhook endpoint URL को redirects का उपयोग नहीं करना चाहिए और यह अंतिम गंतव्य URL होना चाहिए।
यदि आप केवल Primary Profile webhook रजिस्टर करते हैं, तो User Profiles स्वचालित रूप से Primary Profile webhook को inherit करेंगे।
प्रत्येक User Profile के लिए एक अद्वितीय webhook के लिए, आपको प्रत्येक User Profile के लिए एक webhook रजिस्टर करना होगा।
आपके Webhook को
HTTP POST प्राप्त करने के बाद, आपके सर्वर को कॉल को सफल के रूप में चिह्नित करने के लिए
200 की HTTP स्थिति के साथ प्रतिक्रिया देनी चाहिए। यदि आपका सर्वर 10 सेकंड के भीतर प्रतिक्रिया नहीं देता है,
तो एक 503 response रिकॉर्ड किया जाएगा।Webhook Retries
यदि आपके सर्वर से HTTP response200-299 सफलता रेंज में नहीं है, तो सिस्टम स्वचालित रूप से Webhook कॉल को दो और बार पुनः प्रयास करेगा। पहला पुनःप्रयास 5 सेकंड के बाद होगा और दूसरा पुनःप्रयास 30 सेकंड बाद होगा। पुनःप्रयासों में समान hookId होगा और उन्हें प्रयासित पुनःप्रयासों के रूप में चिह्नित किया जाएगा।
Webhook Security
आप HMAC authentication को एक HTTP request के रूप में सेट करके अतिरिक्त सुरक्षा जोड़ना चुन सकते हैं। यह अक्सर replay attacks को रोकने के लिए किया जाता है। Ayrshare message की body को hash करने के लिए HMAC-SHA256 का उपयोग करता है और इसे तथा UNIX timestamp को POST के header में शामिल करता है।X-Authorization-Content-SHA256 की तुलना POST body के HMAC-SHA256 के साथ करके पोस्ट को validate कर सकते हैं। Signing secret profile-wide है — प्रति User Profile एक secret, जो उस profile के सभी webhook actions में उपयोग किया जाता है, इसलिए एक action के लिए इसे सेट करने से उस profile के सभी actions के लिए यह बदल जाता है। Multi-profile accounts प्रति profile एक अलग secret प्रबंधित करते हैं (Profile-Key header के साथ किसी profile को target करें)।
X-Authorization-Content-SHA256-V2 header एक v1=-prefixed मान के रूप में वही signature ले जाता है (v1= HMAC-SHA256 scheme को दर्शाता है)। जब आप अपने signing secret को rotate करते हैं, तो यह header 24-घंटे के grace window के लिए दोनों current और previous signatures (v1=<current-sig>,v1=<previous-sig>) सूचीबद्ध करता है, इसलिए आप शून्य dropped या rejected deliveries के साथ अपने secret को roll कर सकते हैं। एक receiver को एक delivery स्वीकार करनी चाहिए यदि इसका computed HMAC किसी भी सूचीबद्ध v1= signature से मेल खाता है। पूरी प्रक्रिया और सत्यापन उदाहरण के लिए Rotate Signing Secret देखें।