تخطَّ إلى المحتوى

أحداث Webhook

يرسل AD80 كل إشعار إلى Webhook عندك في صورة طلب POST عبر HTTPS بمحتوى JSON.

الترويسةالقيمة
Content-Typeapplication/json
User-AgentAD80-Notify/1
X-AD80-Eventنوع الحدث: creative.violation أو creative.classified أو key.expiring أو digest أو notify.test أو notify.verify.
X-AD80-Deliveryمعرّف التسليم. إعادة المحاولة أو إعادة الإرسال تحتفظ بالمعرّف نفسه.
Idempotency-Keyالقيمة نفسها التي في X-AD80-Delivery.
X-AD80-Timestampوقت Unix (بالثواني) الذي وُقّعت فيه هذه المحاولة.
X-AD80-Signaturev1=<hex>، إدخال واحد لكل سر فعّال، تفصل بينها فواصل. راجع التحقق من التوقيعات.

لكل محتوى المستوى الأعلى نفسه:

الحقلالمعنى
idمعرّف التسليم (نص، ويساوي X-AD80-Delivery).
typeنوع الحدث.
languageen أو ar، حسب الاشتراك.
summaryنسخة نصية مقروءة من الرسالة، بتلك اللغة.
event_id, created_atمعرّف الحدث ووقته (للأحداث المفردة).
dataبيانات الحدث (بالأسفل).
imageلأحداث الإعلانات: url (رابط موقَّع للصورة صالح 7 أيام)، وbase64 (صورة PNG) إن كان الاشتراك مفعّلاً عليه attach_image.
expeditedيظهر بالقيمة false حين يُحجز التنبيه للملخص لأن الرصيد الشهري للإشعارات السريعة نفد.
{
"id": "42",
"type": "creative.violation",
"language": "en",
"event_id": 2,
"created_at": "2026-10-26T14:03:00Z",
"data": {
"appId": "com.example.news",
"contentHash": "ad80px1:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"violates": true,
"verdictId": 5,
"scores": [
{ "rule_id": "no-gambling", "score": 0.91, "reason": "casino chips" },
{ "rule_id": "no-alcohol", "score": 0.12, "reason": "" },
{ "rule_id": "no-weapons", "score": 0.72, "reason": "rifle" }
],
"placementId": "MainActivity/banner_top",
"mediationPlatform": "admob",
"network": { "canonicalId": "meta", "adSourceName": "Meta Audience Network" }
},
"image": {
"url": "https://api.ad80.dev/v1/creatives/ad80px1:aaaa...aaaa/image?exp=1762092180&org=7&sig=..."
},
"summary": "A creative in com.example.news violates 2 rule(s): no-gambling 0.91, no-weapons 0.72.\n\nApp: com.example.news\n..."
}

تسرد scores كل قواعد السياسة، ولكل قاعدة درجتها من 0 إلى 1، ومعها reason للقواعد التي خولفت. أما تحديد القواعد التي تُعدّ مخالَفة فيعود إلى AD80. ولمعرفة قيمة violates لكل قاعدة، استخدم لوحة المتابعة أو GET /v1/creatives/{id}.

له data نفسها التي في creative.violation، وتكون violates إما true أو false. يُرسل مع كل فحص لإعلان تطابقه التصفية في اشتراكك.

{
"id": "43",
"type": "key.expiring",
"language": "en",
"event_id": 6,
"created_at": "2026-10-26T14:03:00Z",
"data": {
"keyKind": "ingest",
"keyId": "ik_3",
"keyLabel": "prod",
"keyPrefix": "ad80_ik_Ab3",
"appId": "com.example.news",
"expiresAt": "2026-10-30T09:00:00Z"
},
"summary": "The ingest key \"prod\" (ad80_ik_Ab3...) for com.example.news expires on 2026-10-30 09:00 UTC. Rotate it before then. ..."
}

يصل إلى اشتراك الملخص (أو إلى تنبيه حُجز بعد نفاد رصيد الإشعارات السريعة) عدة أحداث في رسالة واحدة:

{
"id": "9",
"type": "digest",
"language": "en",
"count": 2,
"events": [
{ "id": 2, "type": "creative.violation", "created_at": "2026-10-26T14:03:00Z", "data": { "appId": "com.example.news", "...": "..." } },
{ "id": 6, "type": "key.expiring", "created_at": "2026-10-26T14:03:00Z", "data": { "keyId": "ik_3", "...": "..." } }
],
"summary": "2 notifications since the last digest. ..."
}

يُرسل حين تضغط أرسل تجربة أو تستدعي نقطة نهاية التجربة:

{
"id": "44",
"type": "notify.test",
"language": "en",
"event_id": 7,
"created_at": "2026-10-26T14:03:00Z",
"data": { "label": "ops", "subscriptionId": 4 },
"summary": "This is a test notification from AD80 for \"ops\". Your destination works. ..."
}

أول رسالة تصل إلى Webhook جديد. ومعرّف التسليم فيها هو verify-<subscription id>.

{
"id": "verify-4",
"type": "notify.verify",
"language": "en",
"event_id": 0,
"created_at": "2026-10-26T14:03:00Z",
"data": { "subscription_id": 4, "code": "vc_THE_CODE" },
"summary": "Confirm this destination to receive AD80 notifications.\nCode: vc_THE_CODE\n..."
}

أعِد data.code لتأكيد الاشتراك. راجع قسم تأكيد الوجهة في واجهة الإشعارات.

  • اقرأ الحقول التي تحتاجها وتجاهل الحقول غير المعروفة، فقد تُضاف حقول جديدة.
  • الحقل summary مكتوب للناس، فلا تحاول تحليله برمجياً.
  • تحقّق من التوقيع على المحتوى الخام قبل أن تحلّله.