Webhooks

Register a mode-scoped webhook endpoint

The signing secret is returned only when the endpoint is first created; updating the same URL never reveals it again. Test and live credentials create separate endpoints, even for the same URL.

post/api/v1/webhooks

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/webhooks
  • Auth: HTTP bearer

Request body

namestring
urlstring uri required

A public HTTPS endpoint.

eventsstring[] required

Response

Existing endpoint updated

object'webhook_endpoint' required
idstring required
namestring
urlstring uri required
eventsstring[] required
secretstring

Signing secret. Returned only when an endpoint is first created.

secret_revealedboolean
is_activeboolean required
livemodeboolean required
created_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.