Skip to main content
GET
Get webhook config (secret masked)

Authorizations

X-API-Key
string
header
required

API key (wg_live_…) created in the dashboard (Account → API Keys). Shown once at creation; only a hash is stored server-side.

Response

Endpoint config with secretPreview (prefix only).

id
string
required
Example:

"whe_Ab12Cd34Ef56"

url
string<uri>
required
status
enum<string>
required
Available options:
active,
disabled
secretPreview
string
required

Masked secret, e.g. whsec_kJ8s2m….

Example:

"whsec_kJ8s2m…"

userId
string
events
enum<string>[] | null

null = subscribed to all events.

Available options:
payment.detected,
payment.confirmed,
order.completed,
order.partial,
order.failed,
refund.initiated,
refund.completed,
refund.failed
previousSecretExpiresAt
integer<int64> | null

End of the dual-signature window after a rotation.

Example:

1753142400000

createdAt
integer<int64>

Unix timestamp in milliseconds (UTC).

Example:

1753142400000

updatedAt
integer<int64>

Unix timestamp in milliseconds (UTC).

Example:

1753142400000