Okta Partners

إرسال إشعار من الكتالوج

POST https://getokta.io/api/apps/notifications/dispatch

يرسل مفتاحاً مُعلَناً في كتالوج تطبيقك إلى مستلمه، والمنصّة تختار القنوات من إعدادات المدرسة. التطبيق Embedded ينادي `App\Services\PartnerApi\Notifications\DispatchNotification` داخلياً بالحمولة نفسها.

  • حدّ المعدّل: MODERATE
    مدى استهلاك هذا الطلب لحصتك: LIGHT أخف من MODERATE ثم HEAVY.
  • النطاق المطلوب: notifications.dispatch.send
    النطاق (scope) الذي يجب أن يمنحه المستأجر لتطبيقك حتى يُسمح بهذا الطلب.
  • الرمز المرجعي: srv_6ff9
    مُعرّف ثابت لهذا الـ endpoint — اذكره عند مراسلة الدعم لتسريع التتبّع.

مُعطيات الجسم

key string مطلوب

مفتاح مُعلَن في كتالوج تطبيقك (`<slug>.<resource>.<event>`). غير المُعلَن يُرفَض بـ422 يسمّيه.

payload.recipient object

`{type, id}` — من يخصّه الإشعار: `parent_of_student` (ulid الطالب)، `host_user` (مُعرّف مستخدم)، `school_admin` (الجهة). غيابه = مستلمو المدرسة المضبوطون. لا يُقرأ أي مفتاح `*_id` عنواناً.

payload.variables object

ما تحلّه `{{ placeholders }}` القوالب. المفاتيح المسطّحة بجانب الحقول المحجوزة تُنقل إلى هنا تلقائياً.

payload.subject string

عنوان يرسمه تطبيقك — يُستعمل حين لا ينطبق قالب.

payload.body string

نصّ يرسمه تطبيقك — ثالث ترتيب المصادر بعد قالب المدرسة ثم `default_template`.

payload.url string

رابط يفتحه الإشعار داخل التطبيق.

payload.locale string

لغة النصّ الذي أرسلته (`ar`/`en`).

payload.metadata object

بيانات لك أنت؛ لا تُطبع.