Webhooks Overview
WebhooksAPI provide real-time notifications to your application about events occurring on platform. This ensures applications can react promptly to events as they happen.
Within a account, some actions happen directly after you ask for them. For example, if you add a new customer, you immediately get back information about that customer. Those instances don’t trigger a webhook, however, other events within an account are asynchronous, occurring at a later time and not as a direct result of your code execution.
Common asynchronous events
- Successful processing of a pending ACH debit charge
- Notifications regarding payouts
- Changes in connected account statuses, which are particularly relevant during the onboarding process
For these asynchronous events, notifies your integration about status changes, enabling your system to take appropriate follow-up actions. The specific responses of your webhook endpoint can vary based on the event type.
Examples of actions triggered by webhooks
- Updating a customer’s membership status
- Emailing a receipt to a customer
- Signaling that an order is ready for fulfillment
How Webhooks Work
Event details are sent in JSON format, with issuing a POST request to your designated notification URL. It's expected that your server acknowledges webhook notifications with a 2xx response code to confirm successful receipt.
webhook endpoints are configured at the partner account level, ensuring that notifications encompass events across all connected accounts.
Retry Behavior
The current retry policy for webhook deliveries involves attempting to send the webhook 6 times over a span of approximately 65 minutes. The approximate intervals between each attempt are as follows:
- 10 seconds for the first retry
- 30 seconds for the second retry
- 2 minutes for the third retry
- 10 minutes for the fourth retry
- 52 minutes for the final retry