Skip to main content
POST
Create a webhook endpoint (platform)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-sp-step-up-token
string
required

Short-lived, single-use SimplePay recent-auth proof bound to this mutation and Idempotency-Key.

Required string length: 32 - 4096
Idempotency-Key
string
required
Required string length: 8 - 255

Body

application/json
enabled_events
enum<string>[]
required
Required array length: 1 - 64 elements
Available options:
*,
account.capability.updated,
account.requirements.updated,
balance.available,
checkout.completed,
checkout.created,
checkout.expired,
dispute.closed,
dispute.created,
dispute.updated,
payment.canceled,
payment.created,
payment.failed,
payment.processing,
payment.succeeded,
payment_link.completed,
payment_link.created,
payment_link.deactivated,
payment_link.updated,
payout.canceled,
payout.created,
payout.failed,
payout.paid,
payout.updated,
refund.created,
refund.failed,
refund.succeeded,
refund.updated
url
string<uri>
required
Maximum string length: 2048
Pattern: ^https://
description
string
Maximum string length: 500

Response

2XX

Forwarded to the owning origin Worker.

Last modified on September 1, 2026