Webhook Subscriptions

Create webhook subscription

Creates a new webhook subscription.

post/v1/webhook_subscriptions

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

urlstring uri required

The HTTPS URL where webhook events will be delivered.

eventsstring[] required

Event types to subscribe to. Use ["*"] for all events.

Response

Success

idstring required

Unique identifier of the webhook subscription.

type'webhook_subscription' required

Resource type discriminator.

urlstring required

The HTTPS URL where webhook events are delivered.

eventsstring[] required

Event types this subscription receives.

created_atstring date-time required

ISO 8601 UTC timestamp when the subscription was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the subscription was last updated.

Changes

Changed in 6 of the 30 revisions of this API.11011

Jul 29, 2026e5198bf3cf7e22See the full diff
- ●
  added the new account_holder.active enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new account_holder.closed enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new account_holder.active enum value to the request property events/items/
  request-property-enum-value-added
- ○
  added the new account_holder.closed enum value to the request property events/items/
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 27, 20261d6de495a31d1See the full diff
- ▲
  the header request parameter Idempotency-Key became required
  request-parameter-became-required
Apr 23, 2026f04b2c330a6733See the full diff
- ●
  added the new conversion.completed enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new conversion.created enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new conversion.failed enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new conversion.completed enum value to the request property events/items/
  request-property-enum-value-added
- ○
  added the new conversion.created enum value to the request property events/items/
  request-property-enum-value-added
- ○
  added the new conversion.failed enum value to the request property events/items/
  request-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 21, 202667983e71dc4111See the full diff
- ●
  added the new deposit.received enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new deposit.received enum value to the request property events/items/
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 15, 2026d91795c11a3144See the full diff
- ●
  added the new return.failed enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new return.initiated enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new return.paid enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new return.returned enum value to the events/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new return.failed enum value to the request property events/items/
  request-property-enum-value-added
- ○
  added the new return.initiated enum value to the request property events/items/
  request-property-enum-value-added
- ○
  added the new return.paid enum value to the request property events/items/
  request-property-enum-value-added
- ○
  added the new return.returned enum value to the request property events/items/
  request-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 14, 20268568afece9121See the full diff
- ○
  endpoint added
  endpoint-added

Full history