API referenceWebhooks
Send a test event
Send a test event
POST
/v1/projects/{projectId}/webhook-endpoints/{id}/send-testQueues a synthetic video.encoding.ready delivery to this endpoint
only, with data.__test = true so receivers can branch in production.
An API key needs the write scope. Rate
limit: 60 requests per 60 s per caller.
Error codes: unauthorized (401), insufficient_scope (403),
endpoint_not_found (404), webhooks_unconfigured (503).
Authentication
- apiKey — Project API key:
Authorization: Bearer vh_live_...(live mode) orAuthorization: Bearer vh_test_...(test mode). Keys carryreadand/orwritescopes.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId | path | string (Ulid) | Yes | — |
id | path | string (Ulid) | Yes | — |
Request body
optional
Content type: application/json
Responses
| Status | Meaning |
|---|---|
202 | The synthetic delivery was queued. |
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. |
429 | Rate limit exceeded. |
Try it
POST
/v1/projects/{projectId}/webhook-endpoints/{id}/send-testTest mode only
API playground
Send a live request to api.videohati.com with a test-mode key.
This playground blocks vh_live_ keys. Use a key that starts with vh_test_ only; a request with a live key never leaves your browser.
The key is stored in your browser on docs.videohati.com only.