Skip to main content
GET
Get a webhook

Authorizations

Authorization
string
header
required

Access token issued by POST /v1/auth/token.

x-zeam-auth
string
header
required

Application secret (the apiKey issued at registration), validated at the Kong edge.

Path Parameters

webhookId
string<uuid>
required

Webhook registration identifier.

Response

The webhook registration.

id
string<uuid>
required
url
string<uri>
required
type
enum<string>
required

The event that triggers delivery. One active registration is allowed per association and event type.

Available options:
IntentInitiated,
IntentProcessing,
IntentFailed,
IntentSuccessful,
IntentRefunding,
IntentRefunded,
IntentRefundFailed,
IntentCancelled
isActive
boolean
required
created
string<date-time>
updated
string<date-time>