Webhooks Webhooks

• 💬 chat.message — a user sent a message
• 🤖 chat.response — the bot replied
• 🆕 session.created — a new conversation started
• ⚠️ quota.warning — you're approaching your usage limit
• 🚫 quota.exceeded — your usage limit was reached
• 📚 kb.updated — a knowledge base entry was added or changed
• ⚙️ tenant.updated — project settings were modified

1. Open your project → Webhooks in the sidebar
2. Click Add Webhook
3. Enter your Endpoint URL — a publicly accessible HTTPS URL on your server
4. Select one or more events to subscribe to
5. Optionally add an HMAC Secret to verify payloads (recommended)
6. Add a Description for your own reference
7. Click Create

On any webhook card, click the ⚡ icon to Send Test Payload. Mugib sends a sample event to your endpoint and shows you:

• ✅ Success / ❌ Failed
• HTTP status code returned
• Round-trip time in milliseconds
• Response body (first 500 characters)

Use this to confirm your server is receiving and responding correctly before relying on it in production.

Click the 🕐 icon on any webhook card to view Delivery Logs. Each log entry shows:

• Which event triggered it
• HTTP status code from your server
• Response time
• Success ✅ or failure ❌

If there are failed deliveries, click Retry Failed to resend the last failed payload.

When you add an HMAC Secret, Mugib signs every payload with SHA-256 and includes the signature in the X-Mugib-Signature header. On your server, verify it like this:

// Node.js example
const crypto = require('crypto');
const signature = req.headers['x-mugib-signature'];
const expected = crypto
  .createHmac('sha256', YOUR_SECRET)
  .update(JSON.stringify(req.body))
  .digest('hex');
if (signature !== expected) return res.status(401).send('Invalid');

Reject any request that fails verification — it wasn't sent by Mugib.

• 💬 chat.message — مستخدم أرسل رسالة
• 🤖 chat.response — البوت ردّ
• 🆕 session.created — محادثة جديدة بدأت
• ⚠️ quota.warning — تقترب من حد الاستخدام
• 🚫 quota.exceeded — تجاوزت حد الاستخدام
• 📚 kb.updated — إدخال قاعدة معرفة أُضيف أو غُيّر
• ⚙️ tenant.updated — إعدادات المشروع عُدّلت

1. افتح مشروعك ← Webhooks في الشريط الجانبي
2. انقر إضافة Webhook
3. أدخل Endpoint URL — رابط HTTPS متاح للعموم على خادمك
4. اختر حدثاً واحداً أو أكثر للاشتراك فيه
5. اختيارياً أضف HMAC Secret للتحقق من الحمولات (موصى به)
6. أضف وصفاً لمرجعك الخاص
7. انقر إنشاء

على أي بطاقة webhook، انقر أيقونة ⚡ لـإرسال حمولة اختبارية. يُرسل مجيب حدثاً نموذجياً لنقطة نهايتك ويُظهر:

• ✅ نجح / ❌ فشل
• كود HTTP المُعاد
• وقت الرحلة الكاملة بالميلي ثانية
• جسم الرد (أول 500 حرف)

انقر أيقونة 🕐 على أي بطاقة webhook لعرض سجلات التسليم. يُظهر كل سجل: الحدث الذي أطلقه، كود HTTP، وقت الاستجابة، ونتيجة النجاح أو الفشل.

إذا كانت هناك تسليمات فاشلة، انقر إعادة المحاولة الفاشلة لإعادة إرسال آخر حمولة فاشلة.

عند إضافة HMAC Secret، يوقّع مجيب كل حمولة بـ SHA-256 ويضمّن التوقيع في header الـ X-Mugib-Signature. على خادمك، تحقق منه هكذا:

// مثال Node.js
const signature = req.headers['x-mugib-signature'];
const expected = crypto
  .createHmac('sha256', YOUR_SECRET)
  .update(JSON.stringify(req.body))
  .digest('hex');
if (signature !== expected) return res.status(401);

ارفض أي طلب يفشل في التحقق — لم يُرسَل من مجيب.