Skip to main content
This API version is deprecated. Please migrate to the latest Webhook definitions which provides a unified webhook endpoint for all event types.

​
What’s Changing

The v1 webhook API used separate endpoints for each event type:
  • /recovery_action - Payment retry instructions
v2 improvements:
  • Single unified /events endpoint for all webhook events
  • Consistent event envelope structure with id, type, created, and data fields
  • Additional event types including complete_dunning
  • Easier to extend and maintain

​
Migration Path

To migrate from v1 to v2:
  1. Update your webhook endpoint to accept POST requests at a single /events path
  2. Parse the type field in the request body to determine the event type
  3. Handle event-specific data from the data field based on the event type
  4. Test with all three event types: recovery_action, pause_invoice, and complete_dunning
⌘I