Register a webhook endpoint

POST/v1/projects/{projectId}/webhook-endpoints

The response contains secret exactly once; only an AES-256-GCM wrapped copy is stored. The URL must be https:// and must not resolve to a private, loopback, link-local, CGNAT, or cloud-metadata address (SSRF defence). An API key needs the write scope. Rate limit: 60 requests per 60 s per caller.

Error codes: unauthorized (401), insufficient_scope (403), not_found (404), invalid_url (400), invalid_body (400), endpoint_limit_reached (409), webhooks_unconfigured (503).

المصادقة

apiKey — Project API key: Authorization: Bearer vh_live_... (live mode) or Authorization: Bearer vh_test_... (test mode). Keys carry read and/or write scopes.

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
`projectId`	path	string (Ulid)	نعم	—

جسم الطلب

إلزامي

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

المخطّط: WebhookEndpointCreateRequest

{
  "url": "https://example.com/webhooks/videohati",
  "description": "Production receiver"
}

الاستجابات

الرمز	المعنى
`201`	Endpoint registered. Store `secret` now; it is never shown again.
`400`	The request body or query failed validation. The per-operation description lists the exact `error.code` values.
`401`	No valid credential was presented.
`403`	The credential is valid but does not permit this action. The per-operation description lists the exact `error.code` values.
`404`	The resource does not exist or is not visible to this caller.
`409`	The request conflicts with the resource's current state. The per-operation description lists the exact `error.code` values.
`429`	Rate limit exceeded.

مثال على الطلب

{
  "url": "https://example.com/webhooks/videohati",
  "description": "Production receiver"
}

جرّبها

POST

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

وضع الاختبار فقط

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

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

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

مفتاح وضع الاختبار

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

جسم الطلب (JSON)