इवेंट स्ट्रीमिंग इंटीग्रेशन

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

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

इंटीग्रेशन का अवलोकन

इंटीग्रेशन का प्रकार

स्रोत: कॉन्फ़िगर किए गए इवेंट ट्रिगर्स के आधार पर Pushwoosh से आपके सिस्टम में डेटा HTTP या gRPC के माध्यम से भेजा जाता है।

इंटीग्रेशन कैसे काम करता है?

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

डेटा केवल तभी भेजा जाता है जब यह चयनित इवेंट्स, प्लेटफ़ॉर्म और वैकल्पिक फ़िल्टर (अभियान/संदेश कोड, लाइव गतिविधि) से मेल खाता हो। क्लाइंट एंडपॉइंट को प्राप्त करने और वैकल्पिक रूप से स्थिति के साथ प्रतिक्रिया देने के लिए तैयार होना चाहिए।

शब्दावली

एंडपॉइंट URL: सर्वर-साइड एंडपॉइंट जो अनुरोध प्राप्त करने की अनुमति देता है। क्लाइंट यदि आवश्यक हो तो एक पोर्ट निर्दिष्ट कर सकता है।

उदाहरण:

• https://clientdomainname.com/webhook_endpoint
• https://clientdomainname.com:8081/webhook_endpoint

सिंक्रनाइज़ की गई इकाइयों की सूची

• संचार सांख्यिकी इवेंट (जैसे, Push Sent, Email Delivered)
• पोस्ट इवेंट्स: वे इवेंट्स जो आपका ऐप postEvent के माध्यम से Pushwoosh को भेजता है, जो संचार सांख्यिकी इवेंट्स से अलग स्ट्रीम किए जाते हैं

उपयोग के मामले

• रीयल-टाइम एंगेजमेंट ट्रैकिंग

उपयोगकर्ता की बातचीत जैसे पुश भेजा गया, ईमेल खोला गया, या संदेश डिलीवर हुआ, जैसे ही वे होते हैं, उनकी निगरानी करें, जिससे अभियान के प्रदर्शन में तत्काल दृश्यता सक्षम हो।

• बाहरी एनालिटिक्स इंटीग्रेशन

केंद्रीकृत रिपोर्टिंग और विश्लेषण के लिए तीसरे पक्ष के एनालिटिक्स प्लेटफ़ॉर्म पर इवेंट स्ट्रीम करें।

• स्वचालित उपयोगकर्ता वर्कफ़्लो

उपयोगकर्ता के व्यवहार के आधार पर बाहरी सिस्टम (जैसे CRM या मार्केटिंग ऑटोमेशन टूल) में क्रियाएं ट्रिगर करें, जैसे, जब कोई उपयोगकर्ता ईमेल खोलता है तो एक फॉलो-अप संदेश भेजें।

• डिवाइस सूची सिंक

जब डिवाइस संदेश प्राप्त नहीं कर सकते, तो उन्हें अपने डेटाबेस से हटाएं। अपंजीकृत डिवाइस को अपने सिस्टम से सिंक करें देखें।

इंटीग्रेशन सेट अप करना

इंटीग्रेशन सेट अप करने के लिए:

1. अपने Pushwoosh खाते में, सेटिंग्स > तृतीय-पक्ष इंटीग्रेशन पर जाएं, इवेंट स्ट्रीमिंग इंटीग्रेशन ढूंढें, और कॉन्फ़िगर करें पर क्लिक करें।

2. खुलने वाली विंडो में, आवश्यक फ़ील्ड भरें।

एंडपॉइंट URL दर्ज करें

एंडपॉइंट URL फ़ील्ड में, वह पूरा URL दर्ज करें जहां इवेंट भेजे जाएंगे, जिसमें यदि लागू हो तो प्रोटोकॉल और पोर्ट भी शामिल है।

उदाहरण

• https://clientdomainname.com/webhook_endpoint
• https://clientdomainname.com:8081/webhook\_endpoint

इवेंट्स चुनें

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

प्राधिकरण क्रेडेंशियल प्रदान करें

यदि आपके सर्वर द्वारा आवश्यक हो, तो प्राधिकरण फ़ील्ड में Authorization हेडर के लिए पूरा मान दर्ज करें।

उदाहरण:

• Bearer your_token_here

• Basic base64encoded_credentials

नोट

यह मान Authorization हेडर (HTTP) या gRPC मेटाडेटा में जैसा है वैसा डाला जाता है। सुनिश्चित करें कि ऑथ स्कीम और टोकन के बीच एक स्पेस है।

ट्रांसपोर्ट प्रकार चुनें

ट्रांसपोर्ट प्रकार ड्रॉपडाउन से, इवेंट ट्रांसमिशन के लिए डिलीवरी प्रोटोकॉल चुनें: HTTP या gRPC। प्रत्येक का विशिष्ट व्यवहार और कॉन्फ़िगरेशन है।

HTTP

HTTP ट्रांसपोर्ट प्रकार के साथ, Pushwoosh इवेंट्स को एक बैच में इकट्ठा करता है और निम्नलिखित में से कोई भी शर्त पूरी होने पर उसे भेजता है:

• 10,000 इवेंट इकट्ठा हो गए हैं, या

• बैच शुरू होने के बाद 5 मिनट बीत चुके हैं।

एक बैच अधिकतम 100 इवेंट या 768 KiB वाले HTTP अनुरोधों में डिलीवर किया जाता है, जो भी सीमा पहले पूरी हो।

डेटा भेजने के बाद, एक सफल प्रतिक्रिया प्राप्त होने पर कनेक्शन बंद हो जाता है।

यदि सर्वर 5xx, 408 या 429 स्टेटस कोड के साथ प्रतिक्रिया करता है, तो Pushwoosh परिभाषित रिट्राई नीति के अनुसार अनुरोध को फिर से प्रयास करता है।

रिट्राई तंत्र

प्रयास	देरी
पहला	1 सेकंड
दूसरा	पहले प्रयास के 3 सेकंड बाद
तीसरा	दूसरे प्रयास के 8 सेकंड बाद

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

यदि आपका एंडपॉइंट 400, 413 या 422 के साथ प्रतिक्रिया करता है, तो Pushwoosh अनुरोध को छोटे अनुरोधों में तब तक विभाजित करता है जब तक अस्वीकृत इवेंट अकेले नहीं भेजा जाता, और फिर उस इवेंट को छोड़ देता है। कोई भी अन्य 4xx प्रतिक्रिया बैच की डिलीवरी रोक देती है: Pushwoosh अधिकतम 2 घंटे तक उसे फिर से भेजने का प्रयास करता है, फिर उसे छोड़ देता है।

यदि आपका एंडपॉइंट 24 घंटे तक लगातार विफल रहता है और कोई भी इवेंट स्वीकार नहीं करता, तो Pushwoosh इंटीग्रेशन को रोक देता है। रोका गया इंटीग्रेशन देखें।

टाइमआउट

एक अनुरोध के लिए डिफ़ॉल्ट टाइमआउट 60 सेकंड है। इसे समर्थन के माध्यम से अनुरोध पर अनुकूलित किया जा सकता है।

उदाहरण देखें

gRPC

gRPC ट्रांसपोर्ट प्रकार डेटा ट्रांसमिशन के लिए द्विदिश स्ट्रीमिंग का उपयोग करता है। gRPC दस्तावेज़ीकरण में और जानें।

एक स्ट्रीम तब खोली जाती है जब निम्नलिखित में से कोई भी शर्त पूरी होती है:

• कम से कम 1,000 इवेंट डिलीवरी के लिए तैयार हैं
• अंतिम स्ट्रीम खोले जाने के बाद एक घंटा बीत चुका है

इवेंट भेजे जाने के बाद स्ट्रीम बंद हो जाती है। यह सुनिश्चित करता है कि कम समय में प्रत्येक व्यक्तिगत इवेंट के लिए एक नई स्ट्रीम नहीं खोली जाती है।

प्रोटोबफ़ स्पेसिफिकेशन देखें

रिट्राई तंत्र
प्रत्येक इवेंट में एक अद्वितीय uuid शामिल होता है। यदि कोई इवेंट विफल होता है:

1. प्रतिक्रिया में एक status शामिल होना चाहिए जो "Success" के बराबर नहीं हो
2. अनुरोध से मूल uuid शामिल होना चाहिए

Pushwoosh इस प्रतिक्रिया के आधार पर डिलीवरी का पुनः प्रयास करेगा।

कनेक्शन सेटिंग्स

उन्नत विकल्प जैसे TLS, keep-alive, या रिट्राई नीतियां समर्थन के माध्यम से मैन्युअल रूप से कॉन्फ़िगर की जाती हैं और इसके लिए विकास भागीदारी की आवश्यकता हो सकती है।

पोस्ट इवेंट्स सक्षम करें

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

दिखाई देने वाले पोस्ट इवेंट्स फ़ील्ड से, चुनें कि आपके खाते के कौन से इवेंट स्ट्रीम करने हैं। टॉगल चालू होने पर कम से-कम एक इवेंट आवश्यक है। यदि आपके खाते ने अभी तक कोई इवेंट नहीं भेजा है, तो यह सूची तब तक खाली रहती है जब तक आप कम से कम एक बार postEvent को कॉल नहीं करते।

नोट

पोस्ट इवेंट्स ऊपर दर्ज किए गए उसी एंडपॉइंट URL पर भेजे जाते हैं, और प्लेटफ़ॉर्म की परवाह किए बिना वहां पहुंचते हैं: नीचे दिए गए प्लेटफ़ॉर्म और उन्नत फ़िल्टर अनुभाग केवल संचार सांख्यिकी इवेंट्स पर लागू होते हैं, पोस्ट इवेंट्स पर नहीं।

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

प्लेटफ़ॉर्म चुनें

प्लेटफ़ॉर्म अनुभाग में, इवेंट स्ट्रीमिंग को सक्रिय करने के लिए कम से कम एक प्लेटफ़ॉर्म चुनें।

समर्थित प्लेटफ़ॉर्म में शामिल हैं:

• iOS, Android, macOS, Windows, Amazon, Safari
• Chrome, Firefox, Internet Explorer, Huawei
• Email, SMS, Line, Xiaomi, WhatsApp

उन्नत फ़िल्टर कॉन्फ़िगर करें

उन्नत फ़िल्टर अनुभाग में, फ़िल्टर का उपयोग करके इवेंट डिलीवरी मानदंडों को परिष्कृत करें:

• लाइव गतिविधि इवेंट्स: लाइव गतिविधि इवेंट्स प्राप्त करने के लिए सक्षम करें। इन इवेंट्स में केवल live_activity_id सहित मेटाडेटा होता है।

• अभियान फ़िल्टर: अभियान कोड द्वारा फ़िल्टर करें। केवल इन अभियानों से जुड़े इवेंट ही डिलीवर किए जाएंगे।

• संदेश फ़िल्टर: संदेश कोड द्वारा फ़िल्टर करें। केवल इन संदेशों से जुड़े इवेंट ही डिलीवर किए जाएंगे।

सभी आवश्यक फ़ील्ड भरने के बाद, अपने इंटीग्रेशन को सहेजने और सक्रिय करने के लिए लागू करें बटन पर क्लिक करें।

नोट

कॉन्फ़िगरेशन परिवर्तन सबमिशन के 15 मिनट के भीतर प्रभावी होंगे।

टिप

उन्नत सेटिंग्स जैसे कस्टम टाइमआउट या gRPC कॉन्फ़िगरेशन के लिए, कृपया समर्थन से संपर्क करें।

अनुरोध विवरण और उदाहरण

एंडपॉइंट	https://exampleclientendpoint.com/webhook_endpoint
HTTP अनुरोध	POST
प्रमाणीकरण	नहीं
अनुरोध प्रकार	स्रोत
अनुरोध का अर्थ	वेबहुक एंडपॉइंट पर अनुरोध भेजें
हेडर्स	Content-Type: application/json

अनुरोध बॉडी का उदाहरण

{
  "event_name": "Email Opened",
  "message_code": "E682-E6D92B9A-53E24868",
  "campaign_id": 961048,
  "platform": "Email",
  "payload": "Welcome to Headway! 👋",
  "application_code": "XXXXX-XXXXX",
  "hwid": "user@example.com",
  "user_id": "USER_ID",
  "timestamp": 1723799271,
  "journey_title": "",
  "journey_point_title": "5_Welcome_ID_new",
  "attributes": null
}

एट्रिब्यूट्स

संचार सांख्यिकी इवेंट्स में, attributes केवल पुश इवेंट्स के लिए पॉप्युलेट होता है, जिसमें उस प्लेटफ़ॉर्म के लिए चैनल-विशिष्ट सामग्री (Android, iOS, आदि) होती है जिस पर पुश भेजा गया था। ईमेल और SMS इवेंट्स में केवल शीर्ष-स्तरीय फ़ील्ड (event_name, platform, payload, आदि) होते हैं। उन इवेंट्स के लिए attributes null होता है। एक पॉप्युलेटेड attributes ऑब्जेक्ट के भीतर, इवेंट के अपने प्लेटफ़ॉर्म के बाहर के फ़ील्ड को खाली मान के रूप में भेजने के बजाय छोड़ दिया जाता है। पूरी फ़ील्ड सूची के लिए webhook.proto देखें।

एक पोस्ट इवेंट अपने एट्रिब्यूट कुंजी/मान जोड़े को attributes.event_attributes में ले जाता है। message_code और payload खाली रहते हैं, क्योंकि एक पोस्ट इवेंट किसी संदेश या अभियान से जुड़ा नहीं होता है।

सावधानी

attributes.geozone पदावनत है: स्रोत संपत्ति एक ऑब्जेक्ट है, संख्या नहीं, इसलिए इस फ़ील्ड में कभी भी वास्तविक मान नहीं था। इसके बजाय attributes.geozone_data से वास्तविक जियोज़ोन पढ़ें। पुराना फ़ील्ड मौजूदा gRPC स्टब्स वाले क्लाइंट के लिए अनुबंध में रहता है।

प्रतिक्रिया
प्रतिक्रिया की बॉडी को अनदेखा कर दिया जाता है। HTTP ट्रांसपोर्ट के साथ, प्रतिक्रिया कोड तय करता है कि इवेंट्स डिलीवर माने जाएंगे या नहीं। 2xx कोड का अर्थ है कि आपके एंडपॉइंट ने उन्हें स्वीकार कर लिया।

अपंजीकृत डिवाइस को अपने सिस्टम से सिंक करें

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

ऐसे इंटीग्रेशन से शुरू करें जो पहले से सेट अप है, जिसमें एंडपॉइंट URL दर्ज है और कम से कम एक प्लेटफ़ॉर्म चुना गया है। फिर:

1. इंटीग्रेशन सेटिंग्स में, पोस्ट इवेंट्स की अनुमति दें चालू करें। पोस्ट इवेंट्स सक्षम करें देखें।
2. पोस्ट इवेंट्स फ़ील्ड में, PW_DeviceUnregistered चुनें।
3. पुश टोकन प्राप्त करने वाले डिवाइस के बारे में भी जानने के लिए, PW_DeviceRegistered चुनें।
4. लागू करें पर क्लिक करें। परिवर्तन 15 मिनट के भीतर प्रभावी होता है।

किसी भी पोस्ट इवेंट की तरह, PW_DeviceUnregistered पोस्ट इवेंट्स सूची में तभी दिखाई देता है जब यह खाते के लिए कम से कम एक बार ट्रिगर हो चुका हो। पोस्ट इवेंट्स सक्षम करें देखें।

इवेंट्स को प्रोसेस करते समय इन सीमाओं का ध्यान रखें:

• डिवाइस का मिलान hwid या user_id से करें, पुश टोकन से नहीं। इवेंट में डिवाइस का hwid, user_id और प्लेटफ़ॉर्म होता है, लेकिन पुश टोकन और अपंजीकरण का कारण नहीं होता। समाप्त हो चुका टोकन और SDK के माध्यम से अपंजीकरण एक जैसे दिखते हैं।
• एक ही डिवाइस को नया टोकन मिलने पर कोई इवेंट नहीं भेजा जाता। PW_DeviceRegistered तभी ट्रिगर होता है जब बिना पुश टोकन वाले डिवाइस को टोकन मिलता है। जो सूची डिवाइस को पुश टोकन के आधार पर सहेजती है, उसमें ऐसे टोकन बने रहते हैं जो अब काम नहीं करते, क्योंकि जब किसी डिवाइस को नया टोकन मिलता है, तो दोनों में से कोई भी इवेंट ट्रिगर नहीं होता।
• ईमेल सदस्यता समाप्त करने से डिवाइस नहीं हटता। ईमेल के लिए, पता डिवाइस पर बना रहता है और Pushwoosh उसे केवल सदस्यता समाप्त के रूप में चिह्नित करता है। जब उपयोगकर्ता ने किसी ईमेल में दिए गए लिंक से सदस्यता समाप्त की हो, तो attributes.event_attributes में उस ईमेल का message_code और campaign_id भी होता है।

कुछ इवेंट्स आपके एंडपॉइंट तक कभी नहीं पहुंच सकते: जिस इवेंट को आपका एंडपॉइंट 400, 413 या 422 के साथ अस्वीकार करता है उसे छोड़ दिया जाता है, और उस बैच को भी जिसे आपका एंडपॉइंट 2 घंटे तक किसी अन्य 4xx कोड के साथ अस्वीकार करता रहता है (HTTP देखें)। ऐसे डिवाइस का पता लगाने के लिए, समय-समय पर जिन डिवाइस को आप टारगेट करते हैं उनके सेगमेंट को CSV में एक्सपोर्ट करें और उसकी तुलना अपनी डिवाइस सूची से करें। सेगमेंट एक्सपोर्ट करने के लिए आपकी भूमिका में Personal data अनुमति होनी चाहिए। यदि आपका एंडपॉइंट 24 घंटे तक लगातार विफल रहता है, तो इंटीग्रेशन रोक दिया जाता है और इवेंट्स आना बंद हो जाते हैं। रोका गया इंटीग्रेशन देखें।

रोका गया इंटीग्रेशन

यदि आपके HTTP एंडपॉइंट पर डिलीवरी 24 घंटे तक लगातार विफल रहती है और उस दौरान एंडपॉइंट कोई भी इवेंट स्वीकार नहीं करता, तो Pushwoosh इंटीग्रेशन को रोक देता है:

• Pushwoosh एंडपॉइंट पर इवेंट्स भेजना बंद कर देता है।
• भेजे जाने की प्रतीक्षा कर रहे इवेंट्स हटा दिए जाते हैं। रोके गए समय के इवेंट्स बाद में नहीं भेजे जाते।
• खाता स्वामी को रोके जाने के बारे में एक ईमेल मिलता है। इंटीग्रेशन सेटिंग्स में रोके जाने की स्थिति नहीं दिखती, इसलिए यह ईमेल ही एकमात्र सूचना है।

जब आपका एंडपॉइंट 2xx प्रतिक्रिया कोड लौटाता है, तो इवेंट स्वीकृत माना जाता है। आंशिक विफलताओं से इंटीग्रेशन नहीं रुकता: कोई भी स्वीकृत इवेंट 24 घंटे की गिनती फिर से शुरू कर देता है। gRPC ट्रांसपोर्ट वाले इंटीग्रेशन नहीं रोके जाते।

स्ट्रीमिंग फिर से शुरू करने के लिए:

1. सुनिश्चित करें कि आपका एंडपॉइंट उपलब्ध है और 2xx प्रतिक्रिया कोड लौटाता है।
2. सेटिंग्स > तृतीय-पक्ष इंटीग्रेशन पर जाएं, इवेंट स्ट्रीमिंग इंटीग्रेशन ढूंढें, और कॉन्फ़िगर करें पर क्लिक करें।
3. लागू करें पर क्लिक करें। आपको कोई सेटिंग बदलने की आवश्यकता नहीं है। स्ट्रीमिंग 15 मिनट के भीतर फिर से शुरू हो जाती है।

आपको कैसे पता चलेगा कि इंटीग्रेशन काम कर रहा है?

आपको अपने कॉन्फ़िगर किए गए एंडपॉइंट पर Pushwoosh से अनुरोध प्राप्त होने लगेंगे।