इनबाउंड वेबहुक इंटीग्रेशन

डेवलपर सहायता की आवश्यकता है

इंटीग्रेशन सेट अप करने के लिए आपको अपनी डेवलपमेंट टीम की मदद की आवश्यकता होगी। कृपया यह गाइड उनके साथ साझा करें।

इनबाउंड वेबहुक बाहरी सेवाओं को सीधे Pushwoosh पर इवेंट भेजने की सुविधा देते हैं। जब कोई थर्ड-पार्टी सिस्टम वेबहुक को ट्रिगर करता है, तो Pushwoosh अनुरोध को प्रमाणित करता है, सब्सक्राइबर की पहचान करता है, और मैप किए गए इवेंट को फायर करता है। फिर इवेंट एक जर्नी शुरू कर सकता है या उसे आगे बढ़ा सकता है।

अपने स्वयं के सर्वर को बनाने या बनाए रखने के बिना CRM, ई-कॉमर्स प्लेटफॉर्म, या एनालिटिक्स सेवाओं जैसे टूल को जोड़ने के लिए इनबाउंड वेबहुक का उपयोग करें। प्रत्येक इनबाउंड वेबहुक एक Pushwoosh इवेंट को तब ट्रिगर करता है जब एक मेल खाने वाला अनुरोध प्राप्त होता है और सफलतापूर्वक संसाधित होता है।

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

वेबहुक सेटअप खोलने से पहले निम्नलिखित तैयार करें।

1. तय करें कि वेबहुक को कौन सा Pushwoosh इवेंट फायर करना चाहिए। अपने प्रोजेक्ट से एक मौजूदा इवेंट चुनें जिसे आप थर्ड-पार्टी सेवा से ट्रिगर करना चाहते हैं। उदाहरण के लिए, CheckoutSuccess। यदि आपके पास अभी तक कोई उपयुक्त इवेंट नहीं है, तो आने वाले डेटा से भरने के लिए इच्छित विशेषताओं के साथ एक बनाएँ।

2. सुनिश्चित करें कि आपकी थर्ड-पार्टी सेवा वेबहुक भेज सकती है। सेवा को एक बाहरी URL पर HTTP POST अनुरोध भेजने में सक्षम होना चाहिए जब वह इवेंट होता है जिसकी आपको परवाह है, उदाहरण के लिए एक नया ऑर्डर या एक फॉर्म सबमिशन।

3. अपनी थर्ड-पार्टी सेवा से एक नमूना JSON पेलोड प्राप्त करें। यह उस डेटा का एक छोटा सा उदाहरण है जो सेवा प्रत्येक इवेंट पर भेजती है। आपको पेलोड फ़ील्ड को Pushwoosh इवेंट विशेषताओं में मैप करने के लिए इसकी आवश्यकता होगी।

वेबहुक बनाएँ

1. अपने Pushwoosh खाते में, Settings → Integrations → Inbound webhooks पर जाएँ और Settings पर क्लिक करें।

2. सेटअप फ्लो खोलने के लिए Create webhook पर क्लिक करें।

3. एक वेबहुक नाम दर्ज करें ताकि आप बाद में सूची में वेबहुक की पहचान कर सकें।

4. उस Pushwoosh इवेंट का चयन करें जो वेबहुक को एक वैध अनुरोध प्राप्त होने पर फायर होना चाहिए। आप अपने प्रोजेक्ट में पहले से मौजूद इवेंट्स में से चुन सकते हैं। यदि आपको पहले एक इवेंट बनाने की आवश्यकता है, तो इवेंट्स देखें।

नोट

एक वेबहुक केवल एक इवेंट को ट्रिगर करता है।

5. Match incoming data में, अपनी थर्ड-पार्टी सेवा से एक नमूना JSON पेलोड पेस्ट करें। Pushwoosh पेलोड फ़ील्ड को स्वचालित रूप से ड्रॉपडाउन में लोड करता है।

नोट

यदि आप बाद में पेलोड अपडेट करते हैं, तो ड्रॉपडाउन को रीफ्रेश करने के लिए Reload select options पर क्लिक करें। यह आपकी वर्तमान फ़ील्ड मैपिंग को रीसेट कर देता है। आपको अपनी विशेषताओं को फिर से मैप करना होगा।

नमूना पेलोड:

{
  "user_id": "12345",
  "email_address": "jane@example.com",
  "mobile": "+15551234567",
  "purchase_date": "2024-03-15",
  "order_number": "ORD-001",
  "price": 99.99,
  "payment_state": "success"
}

6. Identify users by में, चुनें कि Pushwoosh को आने वाले अनुरोध को उपयोगकर्ता से कैसे मिलाना चाहिए:

• User ID: Pushwoosh में आंतरिक उपयोगकर्ता आईडी द्वारा मिलान करता है।
• Email: ईमेल पते से मिलान करता है।
• Phone: फ़ोन नंबर से मिलान करता है।
• HWID: डिवाइस, ब्राउज़र, या ईमेल पहचानकर्ता द्वारा मिलान करता है।

Payload field में, उस फ़ील्ड का चयन करें जिसमें मिलान मान है।

7. प्रत्येक इवेंट विशेषता को एक पेलोड फ़ील्ड में मैप करें। प्रत्येक मैपिंग पंक्ति में:

• Event attribute: Pushwoosh में विशेषता का नाम। इस इवेंट के लिए परिभाषित विशेषताओं में से चुनें।
• Payload field: आने वाले पेलोड से वह फ़ील्ड जिसमें मान है।

उदाहरण के लिए, email को email_address से, total को price से, और order_id को order_number से मैप करें।

एक पंक्ति जोड़ने के लिए + Add attribute पर क्लिक करें। एक को हटाने के लिए × पर क्लिक करें।

8. जब कॉन्फ़िगरेशन पूरा हो जाए, तो Enable पर क्लिक करें। Webhook URL विंडो खुलती है।

डेवलपर सहायता की आवश्यकता है

अगले चरणों के लिए आपकी थर्ड-पार्टी सेवा की वेबहुक सेटिंग्स तक पहुँच की आवश्यकता है। URL और Secret को अपनी डेवलपमेंट टीम के साथ साझा करें।

मानों को कॉपी करें और उन्हें अपने बाहरी सिस्टम की वेबहुक सेटिंग्स में पेस्ट करें:

• URL को कॉपी करें और इसे अपनी थर्ड-पार्टी सेवा में वेबहुक गंतव्य के रूप में सेट करें।
• Secret को कॉपी करें और इसे अपनी बाहरी सेवा में Authorization हेडर मान के रूप में पेस्ट करें। मान में Bearer उपसर्ग शामिल है, इसलिए इसे वैसे ही उपयोग करें। Pushwoosh किसी भी ऐसे अनुरोध को अस्वीकार कर देता है जिसमें यह हेडर गायब है या मेल नहीं खाता है।

9. विंडो एक नमूना POST अनुरोध के साथ एक Example request भी दिखाती है। पूरे अनुरोध को कॉपी करने के लिए उदाहरण ब्लॉक में Copy पर क्लिक करें। इसका उपयोग एक परीक्षण अनुरोध भेजने और यह पुष्टि करने के लिए करें कि Pushwoosh वेबहुक को स्वीकार करता है, या इसे इंटीग्रेशन के लिए एक टेम्पलेट के रूप में अपनी टीम के साथ साझा करें।

वेबहुक को सक्षम करने के बाद, यह वेबहुक सूची में एक सक्षम स्थिति के साथ दिखाई देता है और अनुरोध स्वीकार करना शुरू कर देता है।

वेबहुक सूची

इनबाउंड वेबहुक सूची आपके प्रोजेक्ट में प्रत्येक वेबहुक को दिखाती है।

प्रत्येक पंक्ति दिखाती है:

• Name: वेबहुक का नाम।
• Event: Pushwoosh इवेंट जो वेबहुक को एक वैध अनुरोध प्राप्त होने पर फायर होता है।
• Status: Enabled या Disabled।
• Received: वेबहुक द्वारा प्राप्त अनुरोधों की संख्या।
• Last updated: वेबहुक को अंतिम बार कब बदला गया था।

वेबहुक प्रबंधित करें

पंक्ति मेनू खोलने के लिए:

• Edit settings: वेबहुक कॉन्फ़िगरेशन खोलता है ताकि आप नाम, इवेंट, फ़ील्ड मैपिंग और उपयोगकर्ता पहचान बदल सकें।
• Copy URL: URL और Secret के साथ Webhook URL विंडो खोलता है ताकि आप उन्हें फिर से कॉपी कर सकें।
• Activity log: इस वेबहुक के लिए अनुरोध लॉग खोलता है।
• Delete: सूची से वेबहुक को हटाता है।

एक सक्षम वेबहुक के लिए, कॉन्फ़िगरेशन को हटाए बिना इसे निष्क्रिय करने के लिए Disable पर क्लिक करें। एक अक्षम वेबहुक के लिए, फिर से अनुरोध स्वीकार करना शुरू करने के लिए Enable पर क्लिक करें।

एक्टिविटी लॉग देखें

एक्टिविटी लॉग चयनित वेबहुक के लिए सभी आने वाले अनुरोधों को दिखाता है।

सारांश पैनल

शीर्ष पर, पिछले 24 घंटों के सारांश की समीक्षा करें:

• Hits: प्राप्त हुए आने वाले अनुरोधों की कुल संख्या।
• Success: अनुरोध जहां प्रमाणीकरण पास हो गया, उपयोगकर्ता मिल गया, और इवेंट फायर हो गया।
• Failed: अनुरोध जो संसाधित नहीं हुए थे। एक विफल अनुरोध वेबहुक को नहीं रोकता है। Pushwoosh बाद के अनुरोधों को स्वीकार और संसाधित करना जारी रखता है।

विफलता का कारण	इसका क्या मतलब है
प्रमाणीकरण अस्वीकृत	साझा किया गया सीक्रेट वेबहुक कॉन्फ़िगरेशन से मेल नहीं खाता है। यदि लगातार पाँच अनुरोध इस त्रुटि के साथ विफल होते हैं, तो Pushwoosh आपको एक सूचना भेजता है। फिर से शुरू करने के लिए सीक्रेट अपडेट करें। पुनः सक्रियण की आवश्यकता नहीं है।
उपयोगकर्ता पहचानकर्ता फ़ील्ड गायब है	उपयोगकर्ता पहचान के लिए मैप किया गया पेलोड फ़ील्ड अनुरोध में मौजूद नहीं है।

अनुरोध प्रविष्टियाँ

प्रत्येक प्रविष्टि उपयोगकर्ता पहचानकर्ता (उदाहरण के लिए, User ID या Email), एक Success या Failed बैज, अनुरोध टाइमस्टैम्प, और प्राप्त JSON पेलोड का पूर्वावलोकन दिखाती है। पूरे अनुरोध विवरण का विस्तार करने के लिए Show पर क्लिक करें।

User Explorer में वेबहुक-फायर्ड इवेंट देखें

जब एक वेबहुक अनुरोध सफलतापूर्वक संसाधित हो जाता है, तो Pushwoosh User Explorer में इवेंट रिकॉर्ड करता है। यह कहाँ दिखाई देता है यह इस बात पर निर्भर करता है कि आपने उपयोगकर्ता की पहचान कैसे की है:

• User ID, Email, या Phone: इवेंट उपयोगकर्ता प्रोफ़ाइल पर रिकॉर्ड किया जाता है। उपयोगकर्ता को खोलें और Events history पर जाएँ।
• HWID: इवेंट मिलान करने वाले डिवाइस पर रिकॉर्ड किया जाता है। उपयोगकर्ता को खोलें, Active user devices में डिवाइस ढूंढें, और इसके Events history टैब पर जाएँ।

इवेंट को नाम से ढूंढें और मैप की गई विशेषताओं (उदाहरण के लिए, price या products) और वेबहुक आईडी के साथ __webhook विशेषता देखने के लिए इसका विस्तार करें।

जर्नी के साथ इनबाउंड वेबहुक का उपयोग करें

वेबहुक सक्षम होने और सफलतापूर्वक इवेंट फायर करने के बाद, चयनित इवेंट को ट्रिगर-आधारित जर्नी एंट्री के रूप में उपयोग करें। जब वेबहुक को एक वैध अनुरोध प्राप्त होता है, तो Pushwoosh मैप किए गए इवेंट को फायर करता है। कोई भी जर्नी जो इस इवेंट को एंट्री ट्रिगर के रूप में उपयोग करती है, वह मिलान किए गए उपयोगकर्ता के लिए स्वचालित रूप से शुरू हो जाती है।