`POST /v1/webhook-endpoints`

استخدم حقول الطلب والأذونات الموثقة لنقطة HTTP هذه.

مثال طلب#

curl -X POST 'https://platform.tongai.io/v1/webhook-endpoints' \  -H "Authorization: Bearer $TONG_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: 45be69f1-c266-4a09-a82c-bf3c6303eb03" \  -d '{  "url": "https://your-app.example/events",  "events": [    "operation.accepted"  ]}'

الإعدادات

curl --version

المصادقة#

استخدم مفتاح API على الخادم لحسابك، أو OAuth لحساب كل عميل. لا ترسل المفاتيح في المطالبات أو وسيطات الأدوات.

webhooks:manageoperations:read

المعاملات#

Idempotency-Keystringمطلوب

معرّف UUID، مثل e8aa0a87-6cd9-42eb-975a-b72bf43218c8.

محتوى الطلب#

application/json

urlstringمطلوب

التنسيق: uri.

الحد الأقصى للطول: 2000 محرفًا.

eventsstring[]مطلوب

الحد الأدنى للعناصر: 1.

الحد الأقصى للعناصر: 14.

مخطط الاستجابة#

الاستجابة

JSON

{}

`HTTP 201`

application/json

object

الأخطاء والحدود#

HTTP	الخطأ	الاستئناف
`400`	طلب غير صالح`REQUEST_INVALID`	صحح الحقول المشار إليها في الخطأ قبل إعادة المحاولة.
`401`	بيانات اعتماد غير صالحة`CREDENTIAL_INVALID`	تحقق من بيانات الاعتماد وانتهائها وما إذا أُلغيت.
`402`	أرصدة غير كافية`INSUFFICIENT_CREDITS`	أضف أرصدة إلى الحساب المالك لبيانات الاعتماد ثم تابع العمل المحفوظ.
`403`	الإذن مرفوض`SCOPE_REQUIRED`	استخدم بيانات اعتماد بالأذونات المطلوبة والوصول إلى المورد المحدد.
`404`	المورد غير متاح`RESOURCE_UNAVAILABLE`	تحقق من معرّف المورد وملكيته للحساب المصرح له.
`409`	تعارض القصد`IDEMPOTENCY_CONFLICT`	أعد استخدام القصد مع طلبه الأصلي فقط. استخدم UUID جديدًا لإجراء مختلف.
`429`	تم بلوغ حد الطلبات`RATE_LIMITED`	انتظر المدة المحددة في Retry-After قبل إعادة الطلب نفسه.
`503`	غير متاح مؤقتًا`DEPENDENCY_UNAVAILABLE`	انتظر Retry-After وأعد المحاولة بالقصد نفسه. تحقق من العملية المحفوظة بعد انتهاء مهلة.

المصادقةتُخصم تكلفة مفاتيح API من حساب مالك المفتاح. ويتيح OAuth لكل مستخدم متصل استخدام أرصدته.الأخطاء وحدود الطلباتافهم استجابات الأخطاء وأعد المحاولة بأمان واستأنف عمليات التوليد الفاشلة.الطلبات والسجلاتقبول الطلب لا يعني اكتمال التوليد. تابع المهمة المحفوظة حتى تصبح النتيجة جاهزة.