Get a webhook

Returns a single webhook registration. A registration belonging to another association responds 404, identically to one that does not exist.

GET /webhooks/{webhookId}

Get a webhook

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "type": "IntentInitiated",
  "isActive": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

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), required on every request.

Path Parameters

webhookId · string<uuid> · required

Webhook registration identifier.

Response

200

application/json

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, Beneficiary_PaymentDestination_Approved, Beneficiary_PaymentDestination_Rejected, Customer_Verified, Customer_Rejected

isActive · boolean · required

created · string<date-time>

updated · string<date-time>