Webhooks کیا کرتے ہیں
Webhook کسی مخصوص اسٹور ایونٹ کا ایک subscription ہے۔ جب وہ ایونٹ ہو تو Storeep فوری طور پر ایونٹ ڈیٹا آپ کے بتائے URL (API قسم) یا ای میل پتے (E-mail قسم) کو بھیجتا ہے۔ Webhooks عام طور پر آرڈر ٹریکنگ انٹیگریشنز، CRM syncs، اشتہاری پلیٹ فارم کنورژنز، اور خودکار اطلاعات کے لیے استعمال ہوتے ہیں۔
Webhooks منظم کرنے کے لیے Settings → Webhooks پر جائیں۔
Webhook کی حدیں
- فی اسٹور زیادہ سے زیادہ 20 webhooks۔ 21ویں شامل کرنے کی کوشش پر غلطی ملتی ہے۔
- Webhooks پہلے نئے کی ترتیب میں درج ہوتے ہیں، 40 فی صفحہ۔
Webhook بنانا
Add new webhook پر کلک کریں۔
Activate ٹوگل
چیک ہونے پر (ڈیفالٹ) webhook محفوظ ہوتے ہی لائیو ہو جاتا ہے۔ ایونٹس فوری طور پر dispatch ہوتے ہیں۔ ایونٹس وصول کیے بغیر غیر فعال حالت میں webhook محفوظ کرنے کے لیے غیر چیک کریں۔ آپ کسی بھی وقت ترمیم کر کے webhook فعال یا غیر فعال کر سکتے ہیں۔
Name
- لازمی۔
- زیادہ سے زیادہ 50 حروف۔
- webhooks فہرست میں دکھایا جانے والا وضاحتی لیبل۔ مثال: Facebook CAPI, order created۔
Type
ایونٹ payload کیسے پہنچایا جائے کنٹرول کرتا ہے۔ دو اختیارات:
- API: Storeep آپ کے بتائے URL پر ایونٹ ڈیٹا لے جاتی HTTP POST درخواست بھیجتا ہے۔
- E-mail: Storeep آپ کے بتائے پتے پر ایونٹ ڈیٹا پر مشتمل ای میل بھیجتا ہے۔
Event
وہ اسٹور ایونٹ جو یہ webhook شروع کرتا ہے۔ تین ایونٹس دستیاب ہیں:
- Session created: آپ کے اسٹور میں نیا زائر سیشن بنتے وقت فائر ہوتا ہے۔
- Order created: نیا آرڈر آنے پر فائر ہوتا ہے۔
- Order updated: موجودہ آرڈر کی حالت یا ڈیٹا تبدیل ہونے پر فائر ہوتا ہے۔
Format
ایونٹ payload کا ڈیٹا فارمیٹ۔ فی الحال ایک اختیار:
- Json: payload ایک JSON document کے طور پر بھیجا جاتا ہے۔
URL (صرف API قسم)
- جب قسم API ہو تو لازمی۔
- زیادہ سے زیادہ 500 حروف۔ زیادہ حد ایسے URLs کا احاطہ کرتی ہے جن میں متعدد placeholder حصے ہوں۔
- endpoint URL درج کریں بغیر
https://پریفکس کے۔ یہ خودبخود شامل ہوتا ہے۔ مثال:api.example.com/events/order۔ - Dynamic URL placeholders: ایونٹ payload کا کوئی بھی خانہ double-brace syntax کا استعمال کر کے URL میں inject کیا جا سکتا ہے:
{{field_name}}۔ مثلاً:https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
یہ آپ کو کنورژن ڈیٹا الگ proxy server کے بغیر webhook URL سے براہ راست اشتہاری پلیٹ فارمز کو بھیجنے دیتا ہے۔ - اگر placeholders حل ہونے کے بعد URL کا ڈھانچہ غلط ہو تو آپ کو توثیق کی غلطی ملے گی۔
Email address (صرف E-mail قسم)
- جب قسم E-mail ہو تو لازمی۔
- ایک درست ای میل پتہ ہونا چاہیے، زیادہ سے زیادہ 127 حروف۔
Webhook ترمیم کرنا
ایڈیٹر کھولنے کے لیے کسی webhook قطار پر کلک کریں۔ تمام خانے ترمیم کے قابل ہیں۔ URL خانہ صرف اسی وقت پہلے سے بھرا ہوتا ہے جب موجودہ قسم API ہو، ای میل خانہ صرف اسی وقت جب قسم E-mail ہو۔ قسم بدلنے سے دوسرا خانہ صاف ہو جاتا ہے۔
Webhooks فعال اور غیر فعال کرنا
ایڈیٹر کے اوپر Activate چیک باکس طے کرتا ہے کہ webhook فائر ہو یا نہیں۔ فہرست میں حالت Activated یا Deactivated دکھاتی ہے۔ غیر فعال webhook کوئی ترسیل ریکارڈ نہیں کرتا لیکن حذف نہیں ہوتا، اس لیے آپ بعد میں اسے دوبارہ ترتیب دیے بغیر فعال کر سکتے ہیں۔
Webhooks فہرست کے کالم
- Name: webhook کا لیبل بنانے کی تاریخ کے ساتھ۔
- URL / E-mail: منزل کا پتہ۔
- Type: API یا E-mail۔
- Event: ایونٹ کا نام (Session created، Order created، یا Order updated)۔
- Format: Json۔
- Status: Activated یا Deactivated۔
Webhook حذف کرنا
ایک یا زیادہ webhooks منتخب کریں اور Delete webhooks پر کلک کریں۔ یہ مستقل ہے اور اس subscription کی تمام مستقبل کی ترسیلات بند کر دیتا ہے۔
اشارے اور احتیاط
- آپ ایک ہی ایونٹ کے لیے متعدد webhooks بنا سکتے ہیں، مثلاً Order created دونوں CRM اور اشتہاری پلیٹ فارم کو بھیجیں، ہر ایک الگ webhook اندراج کے طور پر۔
- اگر آپ کے endpoint کو authentication درکار ہو تو ایونٹ ڈیٹا سے
{{placeholder}}کا استعمال کر کے URL query string میں اسناد شامل کریں، یا ایک proxy server ترتیب دیں جو اصل endpoint کو forward کرنے سے پہلے authentication سنبھالے۔ - Session created ایونٹ ہر منفرد زائر سیشن پر فائر ہوتا ہے، جو مقبول اسٹورز پر زیادہ volume ہو سکتا ہے۔ اسے صرف اسی وقت subscribe کریں جب آپ کا endpoint throughput سنبھال سکے۔