Skip to main content

SubscriptionRequest

Webhook registration request

callbackUrlstringrequired

The callback URL to receive events

Example: https://your-callback.url/webhook
eventTypesstring[]required

One or more event types to subscribe to. Account owners may only subscribe to collection events (v1.collection.). Partner accounts may only subscribe to onboarding events (v1.onboarding.).

Possible values: [v1.collection.payment_request.created, v1.collection.payment_request.paid, v1.collection.payment_request.part_paid, v1.collection.payment_request.cancelled, v1.collection.payment_request.payment.created, v1.collection.payment_request.payment.pending, v1.collection.payment_request.payment.received, v1.collection.payment_request.payment.completed, v1.collection.payment_request.payment.failed, v1.collection.payment_request.payment.reversed, v1.collection.payment_request.payment.payout.pending_approval, v1.collection.payment_request.payment.payout.initiated, v1.collection.payment_request.payment.payout.paid, v1.collection.payment_request.payment.payout.failed, v1.onboarding.account.created, v1.onboarding.account.signed_up, v1.onboarding.account.submitted, v1.onboarding.account.approved, v1.onboarding.account.rejected, v1.onboarding.account.onboarded, v1.onboarding.document.approved, v1.onboarding.document.declined, v1.onboarding.document.validation_warnings], >= 1

SubscriptionRequest
{
  "callbackUrl": "https://your-callback.url/webhook",
  "eventTypes": [
    "v1.collection.payment_request.created"
  ]
}