webhook-endpoint-test

Test event sent from the dashboard or the API

WEBHOOK webhook-endpoint-test

default

{
  "event": {
    "id": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
    "type": "webhook-endpoint-test",
    "timestamp": 1793610900
  },
  "payload": {
    "resource": "webhook-endpoint",
    "id": 11069,
    "message": "Test event from AllRide Voucher Platform"
  }
}

Audience: consumer · Trigger: you send a test event · Payload: {resource, id, message}

Verify the x-signing-signature header before you trust the body (Verifying signatures). Deliveries are at least once and unordered; deduplicate on event.id.

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

x-signing-signature · string · required

t=<unix seconds>,s1=<hex HMAC-SHA256 of "<raw body>.<t>" with your first secret>,s2=<the same with your second secret>. Accept the delivery when either signature matches. See Verifying signatures.

Body

application/json

Body of a webhook-endpoint-test webhook.

event · object · required

The event.

Show child attributes

payload · object · required

The resource the event is about, starting with resource and id: the consumer view of the resource, or the fields this event type defines.

Show child attributes

Response

2XX

Acknowledge receipt within 15 seconds.