Register a webhook

Registers a webhook for one event type. Exactly one active registration is allowed per association and event type; registering a type that already has one returns 409, so deactivate the existing one first. The URL must be https (plain http is tolerated in the sandbox only).

POST /webhooks

Register a webhook

cURL

curl --request POST \
  --url https://api.zeam.money/gw/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "url": "https://example.com/zeam/webhooks",
  "type": "IntentSuccessful"
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

Body

application/json

url · string<uri> · required

HTTPS endpoint that receives events. Plain http is tolerated in the sandbox only.

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

Response

201

application/json

Webhook registered.

id · string<uuid> · required

The new registration id.