VideohatiDocs
API referenceWebhooks

List delivery attempts

List delivery attempts

GET/v1/projects/{projectId}/webhook-endpoints/{id}/deliveries

Keyset pagination ordered by created_at then id descending, with optional state and eventType filters. An API key needs read (or write). Rate limit: 60 requests per 60 s per caller.

Error codes: unauthorized (401), insufficient_scope (403), endpoint_not_found (404), invalid_state (400).

Authentication

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

Parameters

NameInTypeRequiredDescription
projectIdpathstring (Ulid)Yes
idpathstring (Ulid)Yes
limitqueryintegerNo
cursorquerystringNoOpaque cursor returned as nextCursor by the previous page.
statequerystring (WebhookDeliveryState)NoFilter by delivery state.
eventTypequerystringNoFilter by external event type.

Request body

This operation takes no request body.

Responses

StatusMeaning
200One page of delivery attempts.
400The request body or query failed validation. The per-operation description lists the exact error.code values.
401No valid credential was presented.
403The credential is valid but does not permit this action. The per-operation description lists the exact error.code values.
404The resource does not exist or is not visible to this caller.
429Rate limit exceeded.

Try it

GET
/v1/projects/{projectId}/webhook-endpoints/{id}/deliveries
Test 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.