Skip to main content
POST
Send a test event

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Path Parameters

webhookEndpointId
integer<uint64>
required

Webhook endpoint id. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

Test event.

message
string

Message in the test payload (at most 200 characters; default "Test event from AllRide Voucher Platform").

Maximum string length: 200

Response

Accepted

Single-object envelope around a WebhookTrigger.

data
object
required

A queued test event or replay: the stored event is PENDING until it is delivered or its last attempt fails.