What are Webhooks?
Webhooks are HTTP POST requests sent by Pooler to a URL you specify when specific events occur. They allow your application to react immediately to events like payment completions, virtual account transactions, and errors.Why Use Webhooks?
Benefits
Real-Time Updates
Receive instant notifications when events occur - no polling required.
Efficient
Reduce API calls and server load by receiving only relevant events.
Reliable
Webhooks include retry mechanisms for failed deliveries.
Event-Driven
Build event-driven architectures that react to changes immediately.
Better UX
Update your application UI in real-time based on payment status.
Automation
Automate workflows based on payment events without manual intervention.
How Webhooks Work
Webhook Flow
Event Occurs
An event occurs in your Pooler account (e.g., payment completed, virtual account payment received).
Webhook Events
Available Events
Pooler sends webhooks for various events:| Category | Event Name | Description |
|---|---|---|
| Payment | payment.initiated | Payment quote created |
| Payment | payment.completed | Payment successfully processed |
| Payment | payment.failed | Payment processing failed |
| Payment | payment.rejected | Payment was rejected |
| Virtual Account | virtual_account.payment_received | Payment received in virtual account |
| Virtual Account | virtual_account.created | Virtual account created |
| Virtual Account | virtual_account.updated | Virtual account updated |
| Recipient | recipient.created | Recipient created |
| Recipient | recipient.verified | Recipient verification completed |
| Recipient | recipient.verification_failed | Recipient verification failed |
| Account | account.balance_low | Account balance below threshold |
| Account | account.updated | Account details updated |
See the Webhook Events API for a complete list of available events.
Setting Up Webhooks
Step 1: Create Webhook Endpoint
Create an HTTP endpoint in your application to receive webhooks:Step 2: Configure Webhook URL
Configure your webhook URL in the Pooler dashboard:- Navigate to Settings → Developers
- Add your webhook URL
- Select events you want to receive
- Save configuration