إرسال إشعارات إدارة Cato عبر Webhooks

نظرة عامة

تقوم تطبيق إدارة Cato (CMA) بإنشاء إشعارات لمجموعة واسعة من الأحداث الأمنية والشبكية في حسابك. يمكنك استخدام تكاملات webhook لتسليم هذه الإشعارات تلقائيًا إلى منصات الطرف الثالث مثل ServiceNow وJira وSlack وZendesk. يسمح ذلك للأنظمة الخارجية باستهلاك بيانات أحداث Cato في الوقت الفعلي وتفعيل سير العمل الآلي لتتبع الحوادث والاستجابة لها.

تدعم Cato نوعين من تكاملات webhook:

  • تستخدم webhooks القياسية طلبات HTTP لإنشاء أو تحديث العناصر في المنصات الخارجية. 

  • تتكامل webhooks المُتداخلة مع خدمة XOps. تستخدم مُعرّفات تداخل لإنشاء وتحديث العناصر التي تمثل دورة حياة القصص الأمنية والشبكية من XOps في أدوات الطرف الثالث. يتطلب الأمر ترخيص XOps.

تكاملات Webhook قابلة للتكوين بشكل كامل. يمكنك تحديد طريقة HTTP (POST أو PUT)، عنوان URL المستهدف، طريقة التحقق من الهوية، وجسم الطلب. تتيح لك القوالب ومتغيرات الحقل تخصيص هيكل الحمولة حسب متطلبات منصة الطرف الثالث.

فهم تكاملات Webhook في Cato

أنواع تكاملات Webhook

تدعم Cato هذه الأنواع من webhooks لدمج حسابك مع منصات الطرف الثالث وإنشاء تدفقات الآلية:

  • تدعم webhooks القياسية مجموعة واسعة من إشعارات CMA، مثل الإشعارات المستندة إلى تنبيهات الحساب أو النظام، وإشعارات مستندة إلى السياسات. تتيح لك تسليم هذه البيانات إلى المنصات الخارجية وتكوين ما إذا كان webhook سينشئ سجلات جديدة أو يقوم بتحديث السجلات الحالية.

  • تم تصميم webhooks المُتداخلة لخدمة XOps. تمدّد الوظائف الخاصة بـ webhook للقصص الأمنية والشبكية، بحيث يتم تعيين كل قصة في CMA إلى سجل في النظام الخارجي ويتم تحديثه مع تقدم القصة. يتطلب الأمر ترخيص XOps.

تدفقات Webhook - الإنشاء أو التحديث

تحدد تدفقات webhook كيفية تواصل CMA مع منصة الطرف الثالث، إما عن طريق إنشاء سجلات جديدة أو تحديث السجلات الحالية:

  • POST (إنشاء) - يقوم بإنشاء عنصر جديد في منصة الطرف الثالث في كل مرة يتم فيها تفعيل webhook. مثال: فتح تذكرة جديدة في ServiceNow في كل مرة يقوم فيها قاعدة جدار الحماية للإنترنت بحظر تدفق حركة المرور.

  • PUT (تحديث) - يقوم بتحديث عنصر موجود في منصة الطرف الثالث. يتضمن الطلب مُعرف العنصر الصحيح في عنوان URL أو الجسم.

طرق المصادقة

عند إنشاء تكامل Webhook، هناك طرق مصادقة مختلفة للاختيار من بينها:

  • Basic - اسم المستخدم وكلمة المرور

  • Bearer - رمز حامِل

  • Custom - رؤوس مخصصة للخدمات التي تتطلب مصادقة فريدة. أضف أزواج المفتاح والقيمة حسب الحاجة.

ملاحظة: إذا كان الوصول إلى الخدمة الثالثة محدودًا لعناوين IP معينة، يرجى الرجوع إلى هذه المقالة لقائمة عناوين IP الخاصة بـ Cato التي تحتاج إلى السماح بها (يجب أن تكون مسجلاً للدخول لعرض هذه المقالة).

تخصيص محتوى الإشعار

يحتوي الحقل المحتوى في القالب على ملخص مقروء مولّد للتنبيه، مشابه لمحتوى تنبيه البريد الإلكتروني. يمكنك اختيار هذه الصيغ للمحتوى: contentText، contentMarkdown، أو contentHTML.

إذا اخترت تخصيص الجسم، هناك عدد من حقول البيانات التي يمكنك استخدامها في محتوى الرسالة. لذا يمكنك تحديد جسم مخصص (أو هيكل)، ثم تضمين حقول بيانات Cato. عند إدخال $، يتم عرض حقول البيانات المتاحة، ثم تختار الحقل المطلوب. تستخدم الحقول الإكمال التلقائي لتصفية القائمة. لمزيد من المعلومات حول حقول Cato، انظر فهم حقول JSON لتكامل التنبيهات.

قيمة افتراضية لحقول ويبهوك

يمكنك تحديد قيم افتراضية مخصصة لحقول webhook الديناميكية لإضافة المرونة عند عدم تضمين قيمة في بيانات الإشعار. يتيح لك تجاوز القيمة الافتراضية NA في عنوان URL الخاص بالـ webhook أو الرؤوس أو الجسم. استخدم التنسيق ${field:defaultValue} لتحديد قيمة الاحتياطي. على سبيل المثال، يمكنك ضبط ${level:medium} إذا لم يتم تعبئة حقل المستوى. في تدفق مترابط، يمكنك أيضًا استخدام معرف تذكرة احتياطي في عنوان URL الخاص بالـ webhook، مثل https://EXAMPLE-INSTANCE.service-now.com/api/now/table/incident/${correlationId:12345}، بحيث يتم التقاط الإشعارات غير المترابطة في تذكرة ServiceNow الافتراضية.

تكاملات Webhook القياسية

تتيح لك الwebhooks القياسية إرسال إشعارات CMA إلى منصات الطرف الثالث لمجموعة واسعة من حالات الاستخدام. أولاً، حدد تعريف webhook للتكامل مع المنصة. ثم حدد أي إشعارات CMA وقواعد السياسات، مثل إجراءات جدار الحماية، ستقوم بتوليد إشعارات باستخدام webhook.

تعريف تكامل Webhook

قم بإنشاء تكامل webhook يرسل الإشعارات عبر العناصر (تذكرة، رسالة Slack، وما إلى ذلك) في أداة الطرف الثالث الخاصة بك. يمكنك تكوين webhook لإنشاء عناصر جديدة باستخدام طلب POST أو تحديث العناصر الحالية باستخدام طلب PUT. يتضمن التكامل إعدادات لعنوان URL وجسم الطلب وطريقة المصادقة ورؤوس مخصصة اختيارية وجسم الرسالة.

بعد تحديد التفاصيل، يمكنك اختبار الاتصال والتحقق من أنه يعمل.

لتحديد تكامل Webhook:

  1. من قائمة التنقل، انقر فوق الحساب > الاشتراكات وحدد علامة تبويب Webhooks.

  2. انقر فوق Webhook جديد. يفتح اللوحة تكامل ويب هوك جديد.

  3. قم بتكوين تفاصيل الWebhook:

    1. أدخل الاسم للتكامل.

    2. انقر على شريط التمرير لتمكين (بالأخضر) أو تعطيل (بالرمادي) التكامل (ممكن افتراضيًا).

  4. قم بتكوين الإعدادات لقالب JSON للتكامل:

    • في البدء من القالب، حدد قالب JSON الافتراضي الذي يملأ إعدادات التكامل.

      يمكنك ضبط وتعديل الحقول لجسم المخصص (انظر أدناه الخطوة 7).

    ملاحظة: إذا اخترت قالبًا مختلفًا، يتم إعادة تعيين الحقول في جسم المخصص. لمزيد من المعلومات حول القوالب، انظر أدناه القوالب والحقول.

  5. قم بتكوين تفاصيل الاتصال:

    1. أدخل URL للخدمة التي تتلقى الويب هوك.

      يمكنك استخدام الحقول كمتغيرات في عنوان URL. اكتب $ لرؤية الحقول المتاحة.

    2. في طريقة الطلب، حدد التدفق لهذا الwebhook: POST أو PUT.

    3. إذا لزم الأمر، قم بتكوين طريقة المصادقة والإعدادات لهذه الخدمة.

  6. (اختياري) في رؤوس مخصصة، حدد المفتاح والقيمة لكل رأس HTTP إضافي للتكامل.

  7. في الجسم المخصص، حدد محتوى إشعار الWebhook:

    1. (اختياري) قم بتخصيص المحتوى في تعديل الجسم.

      • أدخل / كحرف هروب لاستخدام $ في الجسم

      • أدخل $ لتضمين حقول أخرى

      لا يتم استخدام معرف تعقب الاستجابة في تكاملات webhook القياسية

    2. لتحديد قيمة افتراضية، استخدم التنسيق ${field:defaultValue}، على سبيل المثال ${ID:12345}

  8. انقر اختبار. ترسل CMA طلب HTTP للاختبار بمحتوى يتم إنشاؤه تلقائيًا للحقول.

    إذا تمكن التكامل من الاتصال بالخدمة، يتم عرض رسالة نجح الاختبار بنجاح.

    إذا كان هناك خطأ في الاتصال، تعرض الصفحة رمز خطأ HTTP والرسالة المبلغ عنها من قبل الخدمة.

  9. انقر حفظ. يتم حفظ تكامل Webhook وإضافته إلى علامة تبويب Integrations في صفحة Subscriptions.

حدد المُشغّل للاندماجات القياسية للويب هوك

يتم تفعيل webhooks القياسية من خلال إشعارات CMA. يمكنك تكوين نوعين من الإشعارات:

  1. إشعارات CMA: يمكن لـCMA إرسال إشعارات بشكل استباقي حول حسابك، مثل المستخدمين المقفلين والمديرين، أو تحديثات الترخيص. يمكن إرسال هذه الإشعارات مباشرة عبر تكامل webhook.

    لمزيد من المعلومات، انظر تنبيهات مستوى الحساب وإشعارات النظام.

  2. إشعارات قاعدة السياسات: يمكنك تكوين خيار تتبع في قاعدة السياسة لإرسال إشعار إلى webhook كلما تم مطابقة القاعدة.

عند تحديد القواعد في السياسات، يمكنك استخدام منطقة الإجراءات لإرسال الإشعارات عبر تكاملات webhook.

قاعدة Webhook

تكاملات Webhook المتداخلة

تدعم خدمة XOps webhooks المتداخلة التي تمكنك من دمج دورة حياة القصص الأمنية والشبكية من XOps مع منصة الطرف الثالث. بعد تكوين التكامل، تقوم منصة الطرف الثالث بإنشاء تذكرة أو قضية أو رسالة جديدة تلقائيًا عندما تبدأ القصة، ثم تقوم بتحديثها مع تقدم القصة أو حلها.

تستخدم هذه التكاملات حقول التداخل من قصص XOps لرسم كل قصة في CMA إلى تذكرة أو قضية أو رسالة في المنصة الخارجية. هذا يضمن تطبيق التحديثات بشكل متسق على العنصر الصحيح. يتطلب الأمر ترخيص XOps.

تتطلب هذه الاندماجات:

  • اندماج قياسي للويب هوك

  • اندماج مرتبط للويب هوك

  • نوعان من المُشغلات (واحد لكل اندماج)

حدد ويب هوك القياسي

إنشاء تكامل Webhook قياسي لإنشاء العناصر الأولية (تذكرة، رسالة Slack، إلخ) في أداة الطرف الثالث الخاصة بك. سيتم بعد ذلك تحديث هذه العناصر بواسطة تكامل Webhook المترابط.

بعد تحديد التفاصيل، يمكنك اختبار الاتصال والتحقق من أنه يعمل.

لتعريف تكامل Webhook قياسي:

  1. من قائمة التنقل، انقر فوق الحساب > الاشتراكات وحدد علامة التبويب Webhooks.

  2. انقر فوق Webhook جديد. تفتح لوحة تكامل Webhook جديد.

  3. تكوين تفاصيل Webhook:

    1. أدخل الاسم الخاص بالتكامل.

    2. انقر فوق المنزلق لتمكين (أخضر) أو تعطيل (رمادي) التكامل (يكون ممكّنًا افتراضيًا).

  4. تكوين الإعدادات لقالب JSON للتكامل:

    • في ابدأ من القالب، حدد قالب JSON الافتراضي الذي يملأ إعدادات التكامل.

      يمكنك ضبط وتعديل الحقول لـالجسم المخصص (انظر الخطوة 7 أدناه).

    ملاحظة: إذا اخترت قالبًا مختلفًا، يتم إعادة تعيين الحقول في الجسم المخصص. لمزيد من المعلومات حول القوالب، انظر أدناه القوالب والحقول.

  5. تكوين تفاصيل الاتصال:

    1. أدخل URL للخدمة التي تستقبل Webhook.

      يمكنك استخدام الحقول كمتغيرات في URL. اكتب $ لرؤية الحقول المتاحة.

    2. في طريقة الطلب، اختر POST.

    3. إذا لزم الأمر، قم بتكوين طريقة المصادقة والإعدادات للخدمة.

  6. (اختياري) في رؤوس مخصصة، حدد المفتاح والقيمة لكل رأس HTTP إضافي للتكامل.

  7. في الجسم المخصص، حدد محتوى إشعار Webhook:

    1. في معرف الاستجابة التوافقية، حدد العنصر في الطرف الثالث الذي ستستخدمه للتوافق في URL. على سبيل المثال، في ServiceNow قد يكون هذا result.sys_id ، وفي Zendesk قد يكون ticket.id.

    2. (اختياري) تخصيص المحتوى في تحرير الجسم.

      • أدخل / كحرف للاستخدام $ في الجسم

      • أدخل $ لإدراج الحقول الأخرى

    3. لتحديد قيمة افتراضية، استخدم التنسيق ${field:defaultValue}، على سبيل المثال ${ID:12345}

  8. انقر فوق اختبار. يرسل CMA طلب HTTP تجريبي بمحتوى مُولد تلقائيًا للحقول.

    إذا كان بإمكان التكامل الاتصال بالخدمة، يتم عرض رسالة اختبار نجح بنجاح.

    إذا كان هناك خطأ في الاتصال، تعرض الصفحة رمز خطأ HTTP والرسالة المبلغ عنها من قبل الخدمة.

  9. انقر على حفظ. يتم حفظ تكامل Webhook وإضافته إلى علامة التبويب تكاملات في صفحة الاشتراكات.

تعريف Webhook متداخل

قم بإنشاء تكامل Webhook مترابط يرسل الإشعارات عبر العناصر (تذكرة، رسالة Slack، إلخ) في أداة الطرف الثالث الخاصة بك عن طريق تحديث العناصر الموجودة التي تم إنشاؤها في الإجراء السابق.

عند تكوين ويبهوك مترابط، يستخدم URL معرف الترابط لتحديث العنصر الصحيح في المنصة الخارجية. إذا كانت قيمة معرف الترابط فارغة، فلن يمكن مطابقة التحديث مع العنصر الموجود بالفعل وسيتم فقده. لمنع ذلك، أضف معرف العنصر إلى جسم المخصص للويبهوك القياسي الذي ينشئ التذكرة أو القضية أو الرسالة الأصلية. يتيح ذلك للـ webhook المترابط استخدام هذا المعرف كقيمة احتياطية لحقل الترابط، بحيث تستمر التحديثات اللاحقة في التطبيق على العنصر الأصلي طوال دورة حياة القصة.

بعد تحديد التفاصيل، يمكنك اختبار الاتصال والتحقق من أنه يعمل.

لتعريف تكامل Webhook مترابط:

  1. من قائمة التنقل، انقر فوق الحساب > الاشتراكات وحدد علامة التبويب Webhooks.

  2. انقر فوق Webhook جديد. تفتح لوحة تكامل Webhook جديد.

  3. تكوين تفاصيل Webhook:

    1. أدخل الاسم الخاص بالتكامل.

    2. انقر فوق المنزلق لتمكين (أخضر) أو تعطيل (رمادي) التكامل (يكون ممكّنًا افتراضيًا).

  4. تكوين الإعدادات لقالب JSON للتكامل:

    • في ابدأ من القالب، حدد قالب JSON الافتراضي الذي يملأ إعدادات التكامل.

      يمكنك ضبط وتعديل الحقول لـالجسم المخصص (انظر الخطوة 7 أدناه).

    ملاحظة: إذا اخترت قالبًا مختلفًا، يتم إعادة تعيين الحقول في الجسم المخصص. لمزيد من المعلومات حول القوالب، انظر أدناه القوالب والحقول.

  5. تكوين تفاصيل الاتصال:

    1. أدخل URL للخدمة التي تستقبل Webhook. قم بدمج هذا مع عنصر موجود عن طريق إضافة حقل معرف العنصر المترابط.

      يمكنك استخدام الحقول كمتغيرات في URL. اكتب $ لرؤية الحقول المتاحة.

    2. في طريقة الطلب، اختر PUT.

    3. إذا لزم الأمر، قم بتكوين طريقة المصادقة والإعدادات للخدمة.

  6. (اختياري) في رؤوس مخصصة، حدد المفتاح والقيمة لكل رأس HTTP إضافي للتكامل.

  7. في الجسم المخصص، حدد محتوى إشعار Webhook:

    1. (اختياري) تخصيص المحتوى في تحرير الجسم.

      • أدخل / كحرف للاستخدام $ في الجسم

      • أدخل $ لإدراج الحقول الأخرى

    2. لتحديد قيمة افتراضية، استخدم التنسيق ${field:defaultValue}، على سبيل المثال ${ID:12345}

  8. انقر فوق اختبار. يرسل CMA طلب HTTP تجريبي بمحتوى مُولد تلقائيًا للحقول.

    إذا كان بإمكان التكامل الاتصال بالخدمة، يتم عرض رسالة اختبار نجح بنجاح.

    إذا كان هناك خطأ في الاتصال، تعرض الصفحة رمز خطأ HTTP والرسالة المبلغ عنها من قبل الخدمة.

  9. انقر فوق حفظ. يتم حفظ تكامل Webhook وإضافته إلى علامة التبويب تكاملات في صفحة الاشتراكات.

تحديد الزناد لتكامل Webhook القياسي

يتم تنشيط Webhooks القياسية بواسطة الإشعارات من CMA. يمكنك تكوين نوعين من الإشعارات:

  1. إشعارات CMA: يمكن لـ CMA إرسال إشعارات استباقية حول حسابك، مثل المستخدمين والمسؤولين المقفلين، أو تحديثات الترخيص. يمكن إرسال هذه الإشعارات مباشرة عبر تكامل Webhook.

    لمزيد من المعلومات، انظر تنبيهات مستوى الحساب وإشعارات النظام.

  2. إشعارات قواعد السياسات: يمكنك تكوين إعداد التتبع في قاعدة سياسة لإرسال إشعار إلى Webhook عند مطابقة القاعدة.

عند تحديد قواعد في السياسات، يمكنك استخدام منطقة الإجراءات لإرسال الإشعارات عبر تكاملات Webhook.

rule_webhook.png

تحديد المشغل للدمج المترابط باستخدام "تحديد إشعارات الكشف والاستجابة"

باستخدام سياسات الاكتشاف والاستجابة، يمكنك أتمتة إنشاء وتحديث العناصر في منصات الطرف الثالث لقصص XOps المتداخلة. بحيث يعكس نظامك الخارجي دائمًا الحالة الحالية للقصة.

يمكنك تكوين القواعد في السياسة لتشمل:

  • القصة التي تم إنشاؤها: تفعيل Webhook متداخل لإنشاء عنصر جديد

  • القصة المحدثة: تفعيل Webhook متداخل لتحديث نفس العنصر مع تقدم القصة

للحفاظ على تزامن القصص، قم بتكوين قاعدتين: واحدة لإنشاء العنصر عند بدء القصة وواحدة لتحديثه عند تغيير القصة.

لتحديد الزناد لإشعار Webhook:

  1. من قائمة التنقل، انقر على الرئيسية > سياسة الاكتشاف والاستجابة.

  2. اختر علامة تبويب سياسة الاستجابة.

  3. انقر على جديد. تفتح لوحة الإضافة إلى سياسة الاستجابة.

  4. أدخل اسم للقاعدة.

  5. في قسم المصدر، اختر النوع (على سبيل المثال: مضيف، مجال عنوان IP، موقع) ثم اختر عنصر واحد أو أكثر لمصدر القصة لهذه القاعدة (أو يمكنك إدخال عنوان IP).

    القيمة الافتراضية لالمصدر هي أي.

  6. (اختياري) حدد المعايير التي تحدد الخصائص التي يجب أن تتوفر في القصة لمطابقة القاعدة.

  7. اختر الزناد للقاعدة. 

    • القصة التي تم إنشاؤها لإنشاء عناصر جديدة

    • القصة المحدثة لتحديث العناصر الحالية

  8. في تبويب الاستجابة، اختر إرسال إشعار.

  9. في إرسال الإشعارات إلى، اختر التكامل.

  10. في التكامل، حدد تكامل webhooks الذي يرسل الإشعارات.

  11. انقر فوق حفظ. تتم إضافة القاعدة إلى السياسة.

القوالب والحقول

يمكن تخصيص كل webhook بالكامل ليتناسب مع صيغة وسلوك نظام الطرف الثالث الخاص بك. يتم توفير webhook بصيغة JSON ويمكن تعديلها لتتناسب مع هيكل المنصة المستهدفة. استخدم متغيرات حقل Cato للحمولات الثابتة والديناميكية.

بعد اختيار قالب، يمكنك تحرير الجسم كحمولة JSON وحفظه كقالب مخصص. لديك أيضًا خيار تضمين حقول البيانات في JSON، مما سيضع القيمة ذات الصلة في الحمولة (NA إذا لم تكن متاحة).

عند كتابة $، يتم عرض الحقول المتاحة. لمزيد من المعلومات حول حقول Cato، انظر فهم حقول JSON للتكاملات التنبيهية.

يمكنك الاختيار من بين هذه النماذج عند إنشاء webhook:

  • جميع الحقول - يشمل كل حقل متاح

  • أساسي - نموذج يضم الحقول الأكثر استخدامًا

  • Jira - نموذج Jira الأساسي

  • إنشاء تذكرة ServiceNow - يُنشئ تذكرة جديدة في ServiceNow

  • تحديث تذكرة ServiceNow - يُحدّث تذكرة موجودة في ServiceNow

  • Slack - يُرسل رسالة إلى قناة Slack

  • إنشاء تذكرة Zendesk - يُنشئ تذكرة جديدة في Zendesk

  • تحديث تذكرة Zendesk - يُحدّث تذكرة Zendesk موجودة

  • مخصص - تخصيص إعدادات النموذج

يمكنك أيضًا استخدام الحقول عند تحديد عنوان URL لتكامل webhook.

هل كان هذا المقال مفيداً؟

0 من 1 وجدوا هذا مفيداً

لا توجد تعليقات