انٹیگریشنز: باہر جانے والے ویب ہکس

سیٹنگز → انٹیگریشنز (پتہ /app/settings/integrations) اس ورک اسپیس کے ایونٹس آپ کے کسی URL پر بھیجتا ہے، مثلاً کسی آٹومیشن ٹول (Zapier، Make، n8n) یا آپ کے اپنے سرور پر۔ اسے صرف مالک اور ایڈمن دیکھ اور بدل سکتے ہیں۔

مرحلہ وار: اینڈ پوائنٹ شامل کریں

1. سیٹنگز → انٹیگریشنز کھولیں۔
2. اینڈ پوائنٹ URL میں اپنا اینڈ پوائنٹ URL ٹائپ کریں، مثلاً https://your-system.example.com/omnibrand-hook۔ یہ https ہونا چاہیے اور عوامی انٹرنیٹ پر قابلِ رسائی ہونا چاہیے؛ ورنہ ایک سرخ لائن بتاتی ہے کہ کیا مسئلہ ہے ("اینڈ پوائنٹ ایڈریس https:// سے شروع ہونا چاہیے۔ سادہ http:// قبول نہیں ہے۔"، یا یہ کہ اس تک انٹرنیٹ سے نہیں پہنچا جا سکتا)۔
3. ایونٹس کے تحت وہ ایونٹس منتخب کریں جو یہ اینڈ پوائنٹ وصول کرے۔ ہر باکس میں ایک سادہ وضاحت اور ایونٹ کا نام ہوتا ہے، مثلاً post.published ("ایک پوسٹ شائع ہوئی")، post.failed، social_account.token_expired یا social_account.disconnected؛ تمام ایونٹس، بشمول بعد میں شامل ہونے والے کا مطلب * ہے۔ workspace.created اور invitation.accepted بھی موجود ہیں۔ کم از کم ایک منتخب کریں، ورنہ فارم کہتا ہے "کم از کم ایک ایونٹ منتخب کریں۔"
4. اینڈ پوائنٹ شامل کریں پر کلک کریں۔
5. دستخطی راز (ابھی کاپی کریں - صرف ایک بار دکھایا جائے گا): سیکرٹ کے ساتھ، فارم کے اوپر ظاہر ہوتا ہے؛ صفحہ اس تک اسکرول ہوتا ہے تاکہ آپ اسے فون پر بھی دیکھ سکیں۔ اگر اینڈ پوائنٹ مسترد ہو جائے تو سرخ پیغام اسی جگہ ظاہر ہوتا ہے اور صفحہ اس پر سکرول ہو جاتا ہے۔ ابھی راز کو اپنے ریسیونگ سسٹم میں کاپی کریں؛ اومنی برانڈ اسے دوبارہ کبھی ظاہر نہیں کرتا (صرف اس کے آخری چار حروف دکھاتا ہے)۔ اس کے ساتھ سیکرٹ کاپی کریں آپ کے لیے کاپی کرتا ہے۔
6. اینڈ پوائنٹ پر ٹیسٹ بھیجیں پر کلک کریں۔ آپ دیکھتے ہیں ✓ delivered HTTP اسٹیٹس کے ساتھ آپ کا سرور واپس آیا۔ جب یہ ناکام ہوتا ہے تو آپ کو "Not delivered: your server answered [status]." نظر آتا ہے جس میں کیا ٹھیک کرنا ہے، مثلا 405 Method Not Allowed "اس پتے پر POST درخواستیں قبول کرنی چاہئیں۔", 404 Not Found کے لیے "اس پتے پر کچھ جواب نہیں دیتا۔ URL چیک کریں۔", ری ڈائریکٹ کے لیے "یہ دوسرے ایڈریس پر ری ڈائریکٹ ہو گیا، اور ویب ہکس کبھی ری ڈائریکٹس کی پیروی نہیں کرتے۔ حتمی URL رجسٹر کریں۔"; یا، جب سرور تک بالکل نہیں پہنچا جا سکتا، "Not delivered: آپ کا سرور پہنچ نہیں سکا ([reason])۔ URL چیک کریں اور دیکھیں کہ سرور آن لائن ہے۔" ویب ہکس کیسے کام کرتے ہیں کا لنک اس آرٹیکل کو کھولتا ہے۔

ہر اینڈ پوائنٹ

• URL اور ایک بیج فعال یا غیر فعال۔
• "واقعات: ... · خفیہ ••••1234"، جس میں ہر واقعہ اس کی تفصیل کے مطابق ہوتا ہے (مثلا "ایک پوسٹ شائع کی گئی تھی"), اس کے علاوہ "· N مسلسل ناکامیاں" جب ترسیل کی کوششیں ناکام ہو رہی ہوں اور "· N دوبارہ کوشش کے انتظار میں" جبکہ واقعات اپنی اگلی کوشش کا انتظار کرتے ہیں۔
• ایک سرخ لائن "N ناکام ترسیلات - انہیں دوبارہ بھیجنے کے لیے ڈیلیوری ہسٹری کھولیں۔" جب واقعات رک گئے ( نیچے ڈیلیوری ہسٹری اور ری ڈیلیوری دیکھیں)۔
• سوئچ فعال / غیر فعال ہونے والا ڈیلیوری روک دیتا ہے یا دوبارہ شروع ہو جاتا ہے۔ جب تبدیلی محفوظ کی جاتی ہے تو کارڈ پر "کام کر رہا ہے..." اور اس ٹیسٹ بھیجیں اور حذف کریں انتظار ہوتا ہے؛ اگر سوئچ یا حذف کریں ناکام ہو جائے تو وجہ اس اینڈ پوائنٹ کے کارڈ کے نیچے سرخ رنگ میں ظاہر ہوتی ہے، اور صفحہ اس پر سکرول ہو جاتا ہے۔
• ٹیسٹ بھیجیں ایک بار 'webhook.test' نامی ایونٹ بھیجتا ہے (یہ دوبارہ کوشش نہیں کی جاتی اور نہ ہی ہسٹری میں رکھی جاتی ہے)۔
• ڈیلیوری ہسٹری اینڈ پوائنٹ کی حالیہ ڈیلیوریز کو کھولتی ہے (بٹن ڈیلیوری ہسٹری چھپائیں انہیں بند کرتا ہے)۔
• حذف کریں پوچھتا ہے "(address) کا ویب ہک حذف کریں؟ اسے ایونٹس بھیجنا فوراً بند ہو جائے گا اور اس کا دستخطی راز ہمیشہ کے لیے ختم ہو جائے گا۔ اس کے بجائے اسے روکنے کے لیے اس کا سوئچ بند کریں۔" ونڈو کا عنوان ویب ہک حذف کریں؟ ہے؛ اینڈ پوائنٹ فوراً ہٹانے کے لیے حذف کریں پر کلک کریں، یا اسے رکھنے کے لیے منسوخ کریں۔

آپ کا سرور کیا وصول کرتا ہے

JSON باڈی کے ساتھ ایک POST درخواست: id (ایونٹ کی شناخت - دہرائے گئے ایونٹس نظر انداز کرنے کے لیے اسے استعمال کریں)، event (مثلاً post.published)، occurredAt، اور data (ایونٹ کی تفصیلات)۔ ہیڈرز:

• X-OmniBrand-Signature: sha256= اور اس کے بعد خام باڈی کا HMAC-SHA256، جو آپ کے دستخطی راز کی کلید سے بنایا جاتا ہے۔
• X-OmniBrand-Timestamp اور X-OmniBrand-Signature-V2: ٹائم اسٹیمپ، ایک نقطہ، اور باڈی کا HMAC-SHA256 - پرانی دہرائی گئی درخواستیں رد کرنے کے لیے اسے استعمال کریں۔

5 سیکنڈ کے اندر کسی بھی 2xx اسٹیٹس کے ساتھ جواب دیں۔

ری ٹرائیز: OmniBrand کتنی دیر تک کوشش کرتا رہتا ہے

ہر ایونٹ بھیجنے سے پہلے محفوظ ہو جاتا ہے، اس لیے اگر آپ کا سرور - یا ہمارا - ری اسٹارٹ ہو جائے تو کچھ بھی ضائع نہیں ہوتا۔ جب آپ کا سرور 5 سیکنڈ کے اندر 2xx اسٹیٹس کے ساتھ جواب نہیں دیتا (ایرر، ٹائم آؤٹ، ری ڈائریکٹ، کوئی بھی غیر 2xx جواب)، تو ایونٹ کو تقریبا 1 منٹ، 5 منٹ، 15 منٹ، 30 منٹ، 1 گھنٹہ، 2 گھنٹے، 4، 8 گھنٹے اور 12 گھنٹے بعد دوبارہ آزمایا جاتا ہے - تقریبا 28 گھنٹوں میں 10 کوششیں۔ ہر انتظار میں 20٪ تک فرق ہوتا ہے، اس لیے دوبارہ کوششیں ایک ساتھ نہیں آتیں۔ چونکہ دوبارہ کوشش بعد کے ایونٹ کے بعد آ سکتی ہے، 'id' استعمال کریں تاکہ ڈپلیکیٹس کو نظر انداز کیا جا سکے اور 'occurredAt' استعمال کریں تاکہ ایونٹس آرڈر کیے جا سکیں۔

اگر تمام 10 کوششیں ناکام ہو جائیں تو ڈیلیوری ناکام ہو جاتی ہے اور 30 دن تک ہسٹری میں رہتی ہے، جس کے بعد آپ اسے دوبارہ بھیج سکتے ہیں۔

ڈیلیوری ہسٹری اور ری ڈیلیوری

1. اینڈ پوائنٹ پر، ڈیلیوری ہسٹری پر کلک کریں۔ حالیہ ڈیلیوریاں میں پچھلے 30 دن درج ہیں، سب سے نیا پہلے۔
2. ہر قطار میں ایک اسٹیٹس بیج دکھاتا ہے - ڈیلیور ہو گیا، دوبارہ کوشش جاری ہے یا ناکام - ایونٹ کا نام، جب یہ ہوا، "کوشش N آف 10"، "اگلی کوشش" کی دوبارہ کوشش جاری ہے کرنے کے لیے، اور اس کے لیے جو "آخری جواب:" سے گزر نہیں سکا اور آپ کے سرور نے کیا جواب دیا (مثلا "HTTP 503" یا "5 سیکنڈ میں کوئی جواب نہیں")۔
3. ٹک صرف ناکام صرف ناکام شدہ ڈلیوری دیکھی گئی؛ پرانے لوڈز مزید پرانے دکھائیں جب کوئی نہ ہو، تو یہ کہتا ہے "گزشتہ 30 دنوں میں کوئی ناکام ڈیلیوری نہیں ہوئی۔ جو ڈیلیوری دوبارہ کوشش کی جا رہی ہے انہیں ناکام شمار نہیں کیا جاتا۔" ( دوبارہ کوشش جاری ہے کرنے والی ڈیلیوری ابھی ناکام نہیں ہوئی۔)
4. دوبارہ بھیجنے کے لیے، اس کی قطار پر دوبارہ بھیجیں پر کلک کریں۔ یہ فورا بھیجا جاتا ہے: آپ "Delivered." یا "Not Delivered yet (answer) دیکھتے ہیں۔ یہ خودکار طور پر دوبارہ کوشش کی جاتی ہے۔" - دوبارہ ڈیلیور ہونے والا ایونٹ 10 کوششوں کی نئی رن شروع کرتا ہے۔
5. سرور کو ٹھیک کرنے کے بعد سب کو دوبارہ بھیجنے کے لیے، تمام ناکام دوبارہ بھیجیں پر کلک کریں (جب ڈیلیوریز ناکام ہوں تو دکھایا جاتا ہے)۔ آپ دیکھتے ہیں "N ناکام ڈیلیوریز قطار میں ہیں اور ایک منٹ کے اندر ختم ہو جاتی ہیں۔"

ری ڈیلیوری کے لیے اینڈ پوائنٹ آن ہونا ضروری ہے؛ جب یہ غیر فعال ہوتا ہے تو بٹن انتظار کرتے ہیں اور ہسٹری کہتی ہے "یہ اینڈ پوائنٹ غیر فعال ہے۔ اس کا سوئچ آن کریں تاکہ ری ڈیلیور کیا جا سکے۔" وہ ایونٹس جو اینڈ پوائنٹ غیر فعال ہونے کے دوران آتے ہیں، نہ بھیجے جاتے ہیں اور نہ ہی محفوظ کیے جاتے ہیں۔

اگر کچھ غلط ہو جائے

• ری ڈائریکٹس کو کبھی فالو نہیں کیا جاتا؛ آخری یو آر ایل رجسٹر کریں۔ اگر آپ کا ری ڈائریکٹ ہو تو ٹیسٹ کہتا ہے "ڈیلیور نہیں ہوا: آپ کا سرور 301 کو مستقل طور پر منتقل کر دیا گیا۔ یہ کسی دوسرے ایڈریس پر ری ڈائریکٹ ہو گیا، اور ویب ہکس ری ڈائریکٹس کو کبھی فالو نہیں کرتے۔ اس کے بجائے آخری یو آر ایل رجسٹر کریں۔" (جس اسٹیٹس کے ساتھ آپ کے سرور نے بھیجا ہے)۔
• جب کسی اینڈ پوائنٹ کی ہر کوشش پورے دن ناکام ہو جائے (کم از کم 20 کوششیں مسلسل)، تو اینڈ پوائنٹ خودکار طور پر غیر فعال ہو جاتا ہے اور ایڈمنز کو مطلع کر دیا جاتا ہے۔ اس کی ویٹنگ ڈیلیوری کو ناکام نشان زد کیا جاتا ہے۔ ریسیور کو ٹھیک کریں، سوئچ کو دوبارہ فعال کریں، پھر ڈیلیوری ہسٹری کھولیں اور تمام ناکام دوبارہ بھیجیں پر کلک کریں۔

API تک رسائی (ڈویلپرز کے لیے)

صفحے کے نیچے کارڈ API تک رسائی (ڈویلپرز کے لیے) ہے: "پوسٹس بنانے، رابطے شامل کرنے یا اینالیٹکس خودکار طور پر پڑھنے کے لیے OmniBrand کو اپنے سسٹمز، Zapier یا Make سے جوڑیں۔" ایجنسی اور انٹرپرائز پلانز میں اس میں پبلک API کے لیے آپ کی کلیدیں ہوتی ہیں (دیکھیں API تک رسائی)۔ دوسرے پلانز میں یہ "API تک رسائی ایجنسی پلان میں دستیاب ہے۔" اور پلانز دیکھیں لنک دکھاتا ہے۔ اس صفحے کے ویب ہکس ہر پلان میں کام کرتے ہیں۔

جاننے کی باتیں

• اینڈ پوائنٹ صرف اسی ورک اسپیس کے ایونٹس وصول کرتا ہے، نیز اکاؤنٹ کی سطح کے ایونٹس (بلنگ اور اکاؤنٹ کے ایونٹس)۔
• اینڈ پوائنٹ شامل کرتے وقت آپ جس ورک اسپیس میں ہوں، وہ اسی سے تعلق رکھتا ہے۔