Skip to main content
POST

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

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').