فيديوهاتيالتوثيق

تحديث نقطة Webhook

تحديث نقطة Webhook

PATCH/v1/projects/{projectId}/webhook-endpoints/{id}

تدعم هذه العملية مصادقة ملف ارتباط جلسة لوحة التحكم. استدعها من شيفرة خادم موثوقة فقط، ولا تنشئ المتصفحات ملف الجلسة أو تكشفه.

يغيّر enabled أو url أو description، ويعيد التحقق من العنوان ضد SSRF عند تغييره. يحتاج مفتاح المشروع إلى write أو جلسة لوحة التحكم.

حد المعدّل: 60 طلبًا لكل 60 ثانية لكل مستدعٍ.

رموز الخطأ: unauthorized (401), insufficient_scope (403), endpoint_not_found (404), invalid_url (400), invalid_body (400).

المصادقة

  • apiKey — مفتاح المشروع في ترويسة Authorization: Bearer بصيغة vh_live_... للوضع الفعلي أو vh_test_... للوضع التجريبي، ويحمل صلاحية read و/أو write.
  • sessionCookie — ملف ارتباط جلسة لوحة التحكم الذي يضبطه POST /v1/auth/login. تتطلب مسارات الفيديو والتشغيل أيضًا معامل projectId عند استخدام الجلسة.

المعاملات

الاسمالموضعالنوعإلزاميالوصف
projectIdpathstring (Ulid)نعم
idpathstring (Ulid)نعم

جسم الطلب

إلزامي

نوع المحتوى: application/json

المخطّط: WebhookEndpointUpdateRequest

الاستجابات

الرمزالمعنى
200نقطة الاستقبال بعد التحديث.
400فشل التحقق من جسم الطلب أو معاملاته. يذكر وصف العملية قيم error.code الدقيقة.
401لم تُقدَّم بيانات اعتماد صالحة.
403بيانات الاعتماد صالحة لكنها لا تسمح بهذا الإجراء. يذكر وصف العملية قيم error.code الدقيقة.
404المورد غير موجود أو غير مرئي لهذا المستدعي.
429تم تجاوز حد المعدّل.

جرّبها

PATCH
/v1/projects/{projectId}/webhook-endpoints/{id}
وضع الاختبار فقط

منصة API التفاعلية

أرسل طلبًا حيًا إلى api.videohati.com بمفتاح وضع الاختبار.

تحجب هذه المنصة مفاتيح vh_live_. استخدم مفتاحًا يبدأ بـ vh_test_ فقط؛ لن يغادر أي طلب بمفتاح حي متصفحك.

يُحفظ المفتاح في متصفحك على docs.videohati.com فقط.

https://api.staging.videohati.com/v1/projects/{projectId}/webhook-endpoints/{id}