Skip to main content
POST
Deliver a signed sample payload to a candidate callback_url

Authorizations

Authorization
string
header
required

Your Vook API key (mint one from the web app).

Body

application/json
callback_url
string
required

Candidate webhook endpoint. Public https, standard port.

Maximum string length: 2048
Example:

"https://example.com/vook/webhook"

Response

Delivery outcome

delivered
boolean
required

Whether the endpoint answered 2xx

Example:

true

duration_ms
number
required

Round-trip time in milliseconds

Example:

143

status_code
number | null

HTTP status the endpoint answered, null on a transport error

Example:

200

error
string | null

Transport error, null when the endpoint answered

Example:

null