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 selectors to subscribe to. A selector is either an exact event name (for example v1.collection.payment_request.paid) or a prefix ending in .* that subscribes to every event beneath it at any depth (v1.collection.*, v1.collection.payment_request.*, v1.collection.payment_request.payment.*, v1.*). Wildcards expand to the events your account can receive and automatically include event types added later under that prefix. Account owners can receive collection (v1.collection.*) and RFI (v1.rfi.*) events; partner accounts can also receive onboarding (v1.onboarding.*) and connection (v1.connection.*) events. An exact event name outside what your account can receive, or a selector that matches nothing, is rejected with a 400.

Possible values: >= 1

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