Create a webhook endpoint
Registers an HTTPS URL to receive events. Without enabled_events the endpoint receives
every event, including types added later. The response is the only time secret is
shown; store it to verify signatures. Up to 10 endpoints per environment.
Authorizations
Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown
once when created in the dashboard, and are scoped (see x-required-scope on each
operation). Keep them on your server. Live keys are issued after your business is
verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.
Headers
Unique key for this operation. Retries with the same key return the first result.
255"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"
Body
^https://Event types to send, or ["*"] for all, including types added later. Leave it out to
receive every event.
1New event types may be added. Ignore types you don't handle.
checkout_session.expired, escrow.funded, milestone.delivered, milestone.released, escrow.completed, escrow.refunded, dispute.opened, dispute.evidence_requested, dispute.evidence_submitted, dispute.resolved, payout.sent, refund.sent, refund.failed, chargeback.opened, chargeback.closed, payout.failed 200Your own key-value pairs. KetaPay stores them and never reads them.
Response
Webhook endpoint created; secret is shown this once
"webhook_endpoint"failing: deliveries have failed for 3 days; fix the endpoint and re-enable it in the dashboard.
enabled, failing, disabled Your own key-value pairs. KetaPay stores them and never reads them.
Signing secret. Shown only in this response.
"whsec_9f8c1e2d7b6a5f4e3d2c1b0a9f8e7d6c"