Skip to main content
GET
List webhook deliveries

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Page size 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string
default:-createdAt

One sort field; prefix - for descending (sort=field or sort=-field); id is appended as tie-breaker. Another value is a 400 data-failed-validation with the constraint invalid-sort. Default -createdAt.

Example:

"-createdAt"

filter[webhookEndpointId]
string

Filter on webhookEndpointId (equals).

filter[webhookEndpointId][in]
string

Filter on webhookEndpointId (one of, comma-separated). Comma-separated values.

filter[status]
string

Filter on status (equals).

filter[status][in]
string

Filter on status (one of, comma-separated). Comma-separated values.

filter[eventType]
string

Filter on eventType (equals).

filter[eventType][in]
string

Filter on eventType (one of, comma-separated). Comma-separated values.

filter[lastStatusCode][gte]
integer

Filter on lastStatusCode (greater than or equal).

filter[lastStatusCode][lte]
integer

Filter on lastStatusCode (less than or equal).

filter[webhookEventId]
string

Event id (event.id of the body) Filter on webhookEventId (equals).

filter[createdAt][gt]
string<date-time>

Filter on createdAt (greater than).

filter[createdAt][gte]
string<date-time>

Filter on createdAt (greater than or equal).

filter[createdAt][lt]
string<date-time>

Filter on createdAt (less than).

filter[createdAt][lte]
string<date-time>

Filter on createdAt (less than or equal).

Response

A page of results.

Page envelope of WebhookDelivery.

data
object
required

Page body.