Send a test event

Sends a synthetic event to the endpoint synchronously and returns the delivery result - wire up your receiver, then prove the whole path (TLS, signature verification, 2xx) in one call before going live.

• Default event: type: "ping" with an empty data.object - signed exactly like production deliveries
• Or pass event_type to receive a realistic example payload of any catalog event
• The attempt does NOT count toward auto-disable and is not retried - the response tells you what happened immediately

Rate limit: 10 test sends per endpoint per minute. A test send is not recorded as a delivery: it creates no delivery row, so it will NOT appear in GET /v1/webhook_endpoints/{id}/deliveries. The inline response below is the only record of the attempt.

POST /v1/webhook_endpoints/{id}/test

cURL

Ping

curl --request POST \
  --url https://api.vexioncards.one/v1/webhook_endpoints/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{}'

200

Success

{
  "object": "webhook_test_result",
  "delivered": true,
  "response_code": 200,
  "latency_ms": 184,
  "error": null
}

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Headers

Idempotency-Key · string · required

Required on every mutating POST. See Idempotency.

Required string length: 8 - 255

Path Parameters

id · string · required

Endpoint identifier (whk_ prefix).

Pattern: ^whk_[A-Za-z0-9]+$

Body

application/json

event_type · enum<string>

Optional - send a realistic example of this catalog event instead of the default ping.

Available options: customer.created, customer.updated, customer.deleted, customer.pass_installed, customer.pass_uninstalled, card.created, card.updated, card.deleted, custom_field.created, custom_field.updated, custom_field.deleted, product.created, product.updated, transaction.created, transaction.reversed, notification.sent, notification.delivery_updated, location.updated, team_member.added, team_member.updated, team_member.removed, webhook_endpoint.delivery_failed

Example:

"transaction.created"

Response

200

application/json

Test delivery attempted - result inside.

object · string · required

Always "webhook_test_result".

Allowed value: "webhook_test_result"

delivered · boolean · required

True when your receiver returned 2xx within 10 s.

response_code · integer | null · required

HTTP status your receiver returned; null on connection failure/timeout.

latency_ms · integer · required

Round-trip time of the attempt.

error · string | null

Failure reason when not delivered (e.g. 'timeout after 10000 ms', 'TLS handshake failed').