میں آرڈر اور سیشن ایونٹس کسی API یا ای میل کو بھیجنے کے لیے ویب ہکس کیسے سیٹ اپ کروں؟

ویب ہکس کیا کرتے ہیں

ایک ویب ہک کسی مخصوص اسٹور ایونٹ کو سبسکرائب کرتا ہے۔ جب وہ ایونٹ ہوتا ہے، تو Storeep فوراً ایونٹ کا ڈیٹا آپ کے بتائے گئے URL کو (API قسم) یا آپ کے بتائے گئے ای میل ایڈریس کو (E-mail قسم) بھیج دیتا ہے۔ ویب ہکس عام طور پر آرڈر ٹریکنگ انٹیگریشنز، CRM سنکس، ایڈ پلیٹ فارم کنورژنز، اور خودکار اطلاعات کے لیے استعمال ہوتے ہیں۔

ویب ہکس کا انتظام کرنے کے لیے، Settings → Webhooks پر جائیں۔ ویب ہکس دیکھنے یا تبدیل کرنے کے لیے آپ کو settings اجازت درکار ہے۔

ویب ہک کی حدود

• فی اسٹور زیادہ سے زیادہ 20 ویب ہکس۔ 21واں شامل کرنے کی کوشش یہ خرابی واپس دیتی ہے "You have reached the maximum of 20 webhooks per store"۔
• فہرست ویب ہکس کو نئے سے پہلے دکھاتی ہے، فی صفحہ 40 پر صفحہ بندی کے ساتھ۔

ویب ہک بنانا

Add new webhook پر کلک کریں، نیچے دیے گئے فیلڈز بھریں، پھر Add پر کلک کریں۔

Activate

بطورِ ڈیفالٹ چیک شدہ۔ جب چیک ہو، تو ویب ہک محفوظ کرتے ہی فعال ہو جاتا ہے اور مماثل ایونٹس بھیجے جاتے ہیں۔ اسے ان چیک کر کے ویب ہک کو غیر فعال حالت میں محفوظ کریں جو کچھ وصول نہیں کرتا۔ آپ ویب ہک میں ترمیم کر کے اسے کسی بھی وقت بدل سکتے ہیں۔

Name

• ضروری۔ زیادہ سے زیادہ 50 حروف۔
• فہرست میں دکھایا جانے والا ایک وضاحتی لیبل، مثال کے طور پر Facebook CAPI order created۔

Type

• API: Storeep ایونٹ کا ڈیٹا لے کر آپ کے URL کو ایک HTTP POST درخواست بھیجتا ہے۔
• E-mail: Storeep ایونٹ کا ڈیٹا پر مشتمل ایک ای میل آپ کے ایڈریس کو بھیجتا ہے۔

Event

وہ اسٹور ایونٹ جو ویب ہک کو چلاتا ہے۔ تین ایونٹس موجود ہیں:

• Session created: آپ کے اسٹور میں ایک نیا وزیٹر سیشن بنتا ہے۔
• Order created: ایک نیا آرڈر دیا جاتا ہے۔
• Order updated: کسی موجودہ آرڈر کی حیثیت یا ڈیٹا تبدیل ہوتا ہے۔

اہم: E-mail قسم صرف Order created اور Order updated پہنچاتی ہے۔ اگر آپ E-mail کے ساتھ Session created چنتے ہیں، تو ویب ہک محفوظ ہو جاتا ہے مگر کبھی کچھ نہیں بھیجتا۔ اگر آپ کو سیشن ایونٹ درکار ہو تو API قسم استعمال کریں۔

Format

صرف ایک آپشن، Json: پے لوڈ ایک JSON دستاویز کے طور پر بھیجا جاتا ہے۔

URL (صرف API قسم)

• جب قسم API ہو تو ضروری۔ زیادہ سے زیادہ 500 حروف۔
• فیلڈ آپ کے لیے ایک https:// پری فکس دکھاتا ہے، اس لیے صرف ہوسٹ اور پاتھ درج کریں، مثال کے طور پر api.example.com/events/order۔ اگر آپ پورا https:// یا http:// ایڈریس پیسٹ کرتے ہیں، تو محفوظ کرنے سے پہلے پری فکس ہٹا دیا جاتا ہے۔
• متحرک پلیس ہولڈرز: ڈبل بریس سینٹیکس {{field_name}} کے ساتھ ایونٹ ڈیٹا سے کوئی بھی فیلڈ URL میں داخل کریں۔ مثال: example.com/postback?cid={{fbclid}}&payout={{order_total}}۔ قدریں URL اِنکوڈ ہوتی ہیں، اور جس پلیس ہولڈر کا فیلڈ غائب ہو وہ ایک خالی قدر بن جاتا ہے۔ یہ آپ کو پراکسی کے بغیر کنورژن ڈیٹا براہِ راست کسی ایڈ پلیٹ فارم کو بھیجنے دیتا ہے۔
• ایڈریس کی توثیق پلیس ہولڈرز ہٹانے کے بعد ہوتی ہے، اس لیے غلط URL یہ خرابی واپس دیتا ہے "The url you have entered is incorrect"۔

Email address (صرف E-mail قسم)

• جب قسم E-mail ہو تو ضروری۔ ایک درست ایڈریس ہونا چاہیے، زیادہ سے زیادہ 127 حروف۔

ویب ہک میں ترمیم کرنا

ایڈیٹر کھولنے کے لیے کسی بھی قطار پر کلک کریں۔ ہر فیلڈ قابلِ ترمیم ہے۔ URL فیلڈ صرف اُسی وقت پہلے سے بھرتا ہے جب محفوظ کردہ قسم API ہو، اور ای میل فیلڈ صرف اُسی وقت پہلے سے بھرتا ہے جب محفوظ کردہ قسم E-mail ہو۔ لاگو کرنے کے لیے Save پر کلک کریں۔ Activate ان چیک کے ساتھ محفوظ کرنا ویب ہک کو حذف کیے بغیر غیر فعال کر دیتا ہے۔

ویب ہکس فہرست کے کالم

• Name: اس کی تخلیق کی تاریخ کے ساتھ لیبل۔
• URL / E-mail: منزل۔
• Type: API یا E-mail۔
• Event: Session created، Order created، یا Order updated۔
• Format: Json۔
• Status: Activated یا Deactivated۔

ویب ہک حذف کرنا

ایک یا زیادہ قطاریں منتخب کریں اور Delete webhooks پر کلک کریں۔ حذف کرنا مستقل ہے اور اُس سبسکرپشن کی تمام مستقبل کی ترسیلات روک دیتا ہے۔

ترسیل، ری ٹرائیز، اور ناکامی کی ای میلز

یہ سیکشن API ویب ہکس پر لاگو ہوتا ہے۔ E-mail ویب ہکس بھیج کر بھول جانے والے ہیں: انہیں ایک بار بھیجا جاتا ہے، نہ کوئی ری ٹرائی نہ ناکامی کی ٹریکنگ۔

ری ٹرائی کا طرزِعمل

• ہر درخواست کی 5 سیکنڈ کی ٹائم آؤٹ ہوتی ہے۔ اگر کوئی ہدف 5xx خرابی، 429 (ریٹ محدود)، واپس کرے یا تک رسائی نہ ہو سکے (کنکشن خرابی)، تو ترسیل کو ایک عارضی ناکامی سمجھا جاتا ہے اور دوبارہ کوشش کی جاتی ہے۔
• پہلی ترسیل ناکام ہونے کے بعد، Storeep ایکسپوننشل بیک آف کے ساتھ زیادہ سے زیادہ 5 بار دوبارہ کوشش کرتا ہے: تقریباً 30s، 60s، 120s، 240s، پھر 480s بعد۔ آخری ری ٹرائی کے بعد ایونٹ چھوڑ دیا جاتا ہے۔
• 429 کے علاوہ کوئی 4xx جواب (مثال کے طور پر 404 یا 403) کو مستقل ناکامی سمجھا جاتا ہے۔ Storeep اسے دوبارہ کوشش نہیں کرتا، کیونکہ ایک غلط یا مسترد کرنے والا اینڈ پوائنٹ خود بخود ٹھیک نہیں ہوگا۔
• جب آپ کے ایک ہی ایونٹ پر کئی ویب ہکس ہوں، تو ری ٹرائی صرف اُن کو دوبارہ بھیجتا ہے جو ناکام ہوئے۔ جو اینڈ پوائنٹس پہلے ہی کامیابی واپس کر چکے ہیں انہیں چھوڑ دیا جاتا ہے، اس لیے آپ کو نقل شدہ ترسیلات نہیں ملتیں۔

ناکامی کی اطلاع والی ای میل

• Storeep فی ویب ہک لگاتار ناکام ترسیلات گنتا ہے۔ 5 لگاتار ناکامیوں کے بعد، اسٹور مالک کو "Action needed: your Storeep webhook is failing" عنوان والی ایک ای میل، مالک کی زبان میں ملتی ہے، جس میں ویب ہک کا نام، منزل، ایونٹ، اور آخری HTTP اسٹیٹس کوڈ درج ہوتا ہے۔
• آپ کو فی ناکام تسلسل بالکل ایک ای میل ملتی ہے۔ اُس ویب ہک کے بحال ہونے تک مزید کوئی ای میل نہیں بھیجی جاتی۔
• جیسے ہی کوئی ترسیل دوبارہ کامیاب ہوتی ہے، ناکامی کا کاؤنٹر صفر پر دوبارہ سیٹ ہو جاتا ہے اور اطلاع دوبارہ تیار ہو جاتی ہے، اس لیے مستقبل کا کوئی ٹوٹا ہوا تسلسل آپ کو دوبارہ ای میل کر سکتا ہے۔

تجاویز اور خامیاں

• آپ ایک ہی ایونٹ کے لیے متعدد ویب ہکس بنا سکتے ہیں، مثال کے طور پر Order created کو دو الگ اندراجات کے طور پر ایک CRM اور ایک ایڈ پلیٹ فارم دونوں کو بھیجیں۔
• اگر آپ کے اینڈ پوائنٹ کو تصدیق درکار ہو، تو URL کوئری اسٹرنگ میں ایک ٹوکن رکھیں، یا تو ہارڈکوڈ کر کے یا ایونٹ ڈیٹا سے کسی {{placeholder}} کے ذریعے، یا اس کے آگے ایک پراکسی رکھیں جو فارورڈ کرنے سے پہلے تصدیق شامل کر دے۔
• Session created ہر منفرد وزیٹر سیشن کے لیے چلتا ہے اور مصروف اسٹورز پر بہت زیادہ حجم کا ہو سکتا ہے۔ اسے صرف اُسی وقت سبسکرائب کریں جب آپ کا اینڈ پوائنٹ اِس بہاؤ کو سنبھال سکے، اور یاد رکھیں کہ یہ صرف API قسم کے ساتھ کام کرتا ہے۔