Webhooks and events

Where events go, how each delivery went, and the record of every event.

Send Authorization: Bearer vk_test_... on every call. Every route of Webhooks and events.

POST/v1/webhooks/{endpoint_id}/deliveries/{delivery_id}/retrySend one again.

Your API key, scope setup or all. On the card: events. Over HTTP it is made from the contract: fill in each {…} and every value.

Request3 fields

Path

endpoint_idstringrequiredThe webhook endpoint's id (whk_...).

Type: string

delivery_idstringrequiredThe delivery's id (dlv_...).

Type: string

Headers

Idempotency-KeystringSend the same key to retry this call safely for 24 hours.

Type: string

Answers 20013 fields

idstringThe delivery: one event, to one endpoint (dlv_...).

Type: string

object"webhook_delivery"Always webhook_delivery.

Type: "webhook_delivery"

endpoint_idstringThe endpoint (whk_...).

Type: string

event_idstringThe event (evt_...): read it again with GET /v1/events.

Type: string

event_typestring | nullThe event's type; null when the event is gone.

Limits: One of 28 values.

state"pending" | "sending" | "sent" | "failed"pending: waiting for its next try. sending: being sent now. sent: your endpoint answered 2xx. failed: it gave up: after 5 tries, or when the endpoint was turned off or the event is gone.

Type: "pending" | "sending" | "sent" | "failed"

attemptsintegerHow many times it has been tried: 5 at most, waiting 1, 5, 15 and then 60 minutes between them.

Type: integer

next_attempt_atstring | nullWhen it is tried next, as an ISO 8601 time; null when it will not be.

Type: string | null

last_status_codeinteger | nullWhat your endpoint last answered; null when it never answered.

Type: integer | null

last_errorstring | nullWhat last went wrong; null when nothing did.

Type: string | null

attempt_logobject[]Every try, oldest first.

atstringWhen it was tried, as an ISO 8601 time.

Type: string

status_codeinteger | nullWhat your endpoint answered; null when it did not answer.

Type: integer | null

duration_msintegerHow long the try took, in milliseconds: a try waits 10 seconds at most.

Type: integer

errorstring | nullWhat went wrong, such as a timeout; null when it was sent.

Type: string | null

created_atstringWhen the event was queued for this endpoint, as an ISO 8601 time.

Type: string

sent_atstring | nullWhen your endpoint took it, as an ISO 8601 time; null until then.

Type: string | null

HTTP

No sample in your language for this route, so here it is over HTTP.

curl -X POST "$VESTRA_BASE_URL/v1/webhooks/{endpoint_id}/deliveries/{delivery_id}/retry" \  -H "Authorization: Bearer $VESTRA_API_KEY"