Webhooksسجّل webhook
العودة إلى Sofia

Webhooks

سجّل webhook

يسجّل رابط https تستدعيه Sofia بحدث JSON موقّع، مع إعادة المحاولة حتى خمس مرات عند الفشل. يظهر السر مرة واحدة؛ 10 webhooks كحد أقصى.

POSThttps://api.sofia-post.com/api/v1/webhooks
POST/v1/webhooks

يؤثر هذا الطلب على حسابك الحقيقي.

curl -X POST 'https://api.sofia-post.com/api/v1/webhooks' \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://crm.example.com/hooks/sofia","events":["post.published"]}'

التفويضات

  • Authorizationstringمطلوب

    مفتاحك الشخصي أو رمز وصول OAuth، يُرسل كـ Bearer <token>.

الجسم

application/json

  • urlstringمطلوب

    عنوان https الذي تستدعيه Sofia. يُرفض المضيف الذي يُحلّ إلى عنوان خاص أو loopback أو link-local

  • eventsstring[]مطلوب

    الأحداث المراد استلامها

الاستجابة

201application/json

الـ webhook وسرّ توقيعه، يظهر مرة واحدة فقط.

  • idstringمطلوب

    معرّف الـ webhook

  • urlstringمطلوب

    العنوان الذي تستدعيه Sofia

  • eventsstring[]مطلوب

    الأحداث المشترك فيها

  • createdAtstring<date-time>مطلوب

    وقت تسجيل الـ webhook

  • secretstringمطلوب

    مفتاح HMAC-SHA256 الذي يوقّع كل عملية تسليم (Sofia-Signature). يظهر هذه المرة فقط

400

webhook_url_invalid: ليس https، أو مضيف خاص أو loopback أو link-local. webhook_event_invalid: حدث غير معروف، أو لا حدث.

401

الرمز مفقود أو غير معروف أو منتهي الصلاحية أو ملغى.

403

لا يملك الرمز النطاق webhooks:write.

409

webhook_limit_reached: يوجد 10 webhooks بالفعل.

4XXapplication/json

أي خطأ آخر، ضمن غلاف الخطأ.