رسائل Webhook
آخر تحديث
أرسل أحداث AI CodeOps إلى Slack أو Discord أو Teams أو إلى نقطة نهاية HTTPS خاصة بك، وتحقق من الحمولات الموقّعة، واستدع خط النشر لديك حين يدمج تغيير.
يرسل AI CodeOps رسائل webhook إلى الخارج؛ ولا يستقبلها. ويمكنك:
- إرسال أحداث مساحة العمل إلى تطبيق محادثة أو إلى نقطة نهاية خاصة بك، عبر نقاط نهاية الإشعارات؛
- استدعاء خط النشر لديك حين يدمج طلب سحب من AI CodeOps، عبر عناوين webhook للنشر.
لا webhooks واردة من Git
لا تسجل الجلسات أي webhook على مستودعاتك. يعمل AI CodeOps مع GitHub و GitLab و Bitbucket و Gitea و Forgejo عبر الحساب الذي تربطه، ويتحقق من حالة طلب السحب بسؤال خدمة استضافة Git لديك. والـ webhook الوحيد الذي يضيفه يكون على المستودع الذي تربطه من Build & Test → Builds، ليبدأ الدفع أو طلب السحب عملية بناء. وخادم Git المدار ذاتيا لا يحتاج أيضا إلى webhook وارد للجلسات، لكن يجب أن يستطيع AI CodeOps الوصول إليه: استخدم عنوان https العام له (والخادم الواقع على شبكة خاصة لا يعمل إلا إذا أضافه المشغل إلى قائمة السماح). راجع ربط GitHub وأدلة Git الأخرى.
نقاط نهاية الإشعارات
أضف نقطة نهاية
- افتح Configure → Settings وابحث عن Notification endpoints.
- اختر Add endpoint (إضافة نقطة نهاية).
- املأ الحقول التالية: - الحقل Name: مثل "On-call Slack channel". - الحقل Kind: النوع Slack أو Discord أو MS Teams أو Generic webhook. - الحقل Target URL: عنوان incoming-webhook من تطبيق المحادثة لديك، أو نقطة النهاية الخاصة بك. - الحقل Min severity: القيمة info (all) أو low+ أو medium+ أو high+ أو critical only. - الحقل Events to send: ضع علامة على الأحداث التي تريدها. وعدم وضع أي علامة يعني كل الأحداث. - الحقل Signing secret (لنوع Generic webhook فقط): 8 أحرف على الأقل.
- اختر Create endpoint (إنشاء نقطة النهاية).
يستطيع المالكون والمسؤولون ومسؤولو DevOps إدارة نقاط النهاية. راجع الأدوار والصلاحيات.
يجب أن يكون العنوان المستهدف عنوان HTTPS عاما. وترفض عمليات التسليم إلى localhost أو الشبكات الخاصة أو عناوين البيانات الوصفية السحابية، ولا تتبع إعادات التوجيه.
الأحداث
| الحدث | النوع | متى |
|---|---|---|
| Deploy failed | deployment.failed | فشلت عملية نشر |
| Deploy succeeded | deployment.completed | نجحت عملية نشر |
| Deploy recorded | deployment.recorded | أي سجل نشر، بأي حالة |
| Incidents & policy | policy_decision.recorded | تفتح حادثة أو تتغير، أو تتخذ سياسة قرارا |
| Approval requested | approval.requested | طلب ينتظر قرارا |
| Approval decided | approval.decided | ووفق على طلب أو رفض |
| Run completed | workflow_run.completed | انتهت جلسة |
| New finding | agent_finding.created | أثارت مراجعة ملاحظة |
| Schedule failed | schedule.failed | تعذر تشغيل سير عمل مجدول |
حين لا توضع علامة على أي حدث، تتلقى نقطة النهاية أيضا تحديثات تقدم الجلسات وخطوات الوكلاء.
الحقل Min severity لا يصفي إلا الأحداث التي تحمل درجة خطورة، مثل الملاحظات والحوادث والجداول الفاشلة. والأحداث التي لا تحملها ترسل دائما.
الحمولات
يتلقى Slack و Microsoft Teams الحمولة {"text": "<summary>"}. ويتلقى Discord الحمولة {"content": "<summary>"}. والملخص سطر واحد، مثل:
Deploy prj_01JA2B3C4D5E6F7G8H9J0K1M2R → production @ 3f9c2a1b: failed — The deploy webhook answered HTTP 502.
أما النوع Generic webhook فيتلقى الملخص والحدث بصيغة JSON، مع الترويسة Content-Type: application/json، كما يلي:
{
"summary": "Deploy prj_01JA2B3C4D5E6F7G8H9J0K1M2R → production @ 3f9c2a1b: failed — The deploy webhook answered HTTP 502.",
"event": {
"kind": "deployment.failed",
"workspaceID": "wrk_01JA2B3C4D5E6F7G8H9J0K1M2N",
"entityID": "dep_01JA2B3C4D5E6F7G8H9J0K1M2P",
"workflowRunID": "wfr_01JA2B3C4D5E6F7G8H9J0K1M2Q",
"status": "failed",
"emittedAt": "2026-10-18T09:00:00.000Z",
"metadata": {
"projectID": "prj_01JA2B3C4D5E6F7G8H9J0K1M2R",
"environment": "production",
"sequence": 3,
"commitSHA": "3f9c2a1b7d4e5f60718293a4b5c6d7e8f9012345",
"strategy": "rolling",
"errorSummary": "The deploy webhook answered HTTP 502."
}
}
}
في كل حدث الحقول kind و workspaceID و entityID و emittedAt. وتظهر الحقول workflowRunID و status و metadata حين تنطبق. والحدث خفيف: اجلب التفاصيل من لوحة التحكم إذا احتجت إليها.
تحقق من التوقيع
النوع Generic webhook الذي له سر توقيع يرسل ترويستين:
X-CodeOps-Signature: sha256=<hex HMAC-SHA256 of the raw body, keyed with your secret>
X-CodeOps-Event: deployment.failed
للتحقق، احسب قيمة HMAC-SHA256 لجسم الطلب الخام بسرك وقارنها بالترويسة في زمن ثابت. وهذا مثال بلغة Node.js:
import { createHmac, timingSafeEqual } from "node:crypto"
function verify(rawBody, header, secret) {
const expected = "sha256=" + createHmac("sha256", secret).update(rawBody).digest("hex")
return header.length === expected.length && timingSafeEqual(Buffer.from(header), Buffer.from(expected))
}
استخدم بايتات الجسم كما وصلت بالضبط، قبل تحليل JSON. وليس في التوقيع طابع زمني، فلإسقاط المكررات، استخدم kind و entityID و emittedAt معا؛ وتبقى قيمة emittedAt كما هي حين تعاد محاولة التسليم.
الاختبار وإعادة المحاولة وسجل التسليم
لكل نقطة نهاية الأزرار Test و Deliveries و Disable و Delete.
- الزر Test يرسل حدثا نموذجيا فورا، أيا كانت مرشحات نقطة النهاية.
- الزر Deliveries يعرض كل محاولة مع حالتها ونوع الحدث وحالة HTTP ورقم المحاولة وزمن الاستجابة والتفاصيل. ويحفظ سجل التسليم 30 يوما.
- تنتهي مهلة التسليم بعد 8 ثوان. وتعاد محاولة أخطاء الشبكة وانتهاء المهلة وحالات HTTP 408 و 425 و 429 و 500 و 502 و 503 و 504 بعد 30 ثانية ثم دقيقتين ثم 8 دقائق. والأخطاء الأخرى لا تعاد محاولتها.
- بعد 10 عمليات تسليم فاشلة متتالية، تعطل نقطة النهاية. أصلحها واختر Enable (تفعيل).
لا يوجد نموذج تعديل بعد: لتغيير نقطة نهاية، احذفها وأضفها من جديد.
عناوين webhook للنشر
عنوان webhook للنشر يستدعي خط النشر لديك حين يدمج طلب سحب من AI CodeOps من لوحة التحكم.
- افتح Release → Deployments واختر Deploy targets (وجهات النشر).
- لكل مشروع، أدخل العنوان في Deploy webhook URL، والبيئة في Environment، وسر توقيع اختياريا في Signing secret.
- احفظ.
عند الدمج، يرسل AI CodeOps ما يلي:
{
"event": "pr_merged",
"workspaceID": "wrk_01JA2B3C4D5E6F7G8H9J0K1M2N",
"projectID": "prj_01JA2B3C4D5E6F7G8H9J0K1M2R",
"repo": "acme/api",
"prNumber": 42,
"prUrl": "https://github.com/acme/api/pull/42"
}
ومع سر توقيع يضيف الترويسة X-CodeOps-Signature: sha256=…، محسوبة بالطريقة نفسها المذكورة أعلاه. ويجب أن يكون العنوان HTTPS عاما. وتستطيع قاعدة release.deploy في سياسة مساحة العمل منع النشر التلقائي إلى بيئة.
الخطوات التالية
الأسئلة الشائعة
هل أحتاج إلى إضافة webhook إلى مستودع Git لدي؟
ليس للجلسات، فهي تتحدث إلى خدمة استضافة Git لديك برمز اتصالك. ولا يحصل على webhook إلا المستودع الذي تربطه من Build & Test → Builds، ويضيفه AI CodeOps لك، ليبدأ الدفع أو طلب السحب عملية بناء.
هل حمولات الإشعارات موقّعة؟
حمولات Generic webhook التي لها سر توقيع توقّع بخوارزمية HMAC-SHA256 في الترويسة X-CodeOps-Signature. أما رسائل Slack و Discord و Teams فغير موقّعة.
ماذا يحدث إذا كانت نقطة النهاية لدي متوقفة؟
يعاد إرسال عمليات التسليم الفاشلة بعد 30 ثانية ثم دقيقتين ثم 8 دقائق. وبعد 10 حالات فشل متتالية تعطل نقطة النهاية.