Skip to main content
Registers an endpoint that Blockra will POST events to. Requires the webhooks:write scope. See Webhooks for the payload shape and signature verification.
The signing secret (whsec_…) is returned once, in this response, and never again. Store it securely — you need it to verify webhook signatures.

Request

POST https://api.blockra.io/webhooks

Body parameters

string
required
The HTTPS endpoint to deliver events to.
array
required
The events to subscribe to. One or more of payment.confirming, payment.completed, payment.expired.

Response

string
The endpoint ID, prefixed whk_.
string
The delivery URL.
array
The subscribed events.
string
The signing secret (whsec_…). Returned only here, on creation.
boolean
Whether the endpoint is receiving events.
string
ISO-8601 creation time.