Webhook Notifications
Overview​
Webhooks allow you to receive real-time notifications about contract events. Instead of polling the API for updates, WePay will send HTTP POST requests to your specified endpoint whenever important events occur.
Key Benefits:
- Real-time Updates: Get notified immediately when events occur
- Reduced API Calls: No need to poll for status changes
- Reliable Delivery: Automatic retries with exponential backoff
- Secure: HMAC-SHA256 signature verification
Webhook Event Types​
WePay sends webhooks for the following events:
| Event Type | Description |
|---|---|
| contract.created | A new contract has been created |
| contract.approved | Contract has been approved by the other party |
| contract.rejected | Contract has been rejected |
| contract.cancelled | Contract has been cancelled |
| payment.completed | Payment has been completed and funds are in escrow |
| contract.released | Funds have been released to the seller |
| contract.disputed | A dispute has been raised on the contract |
| contract.completed | Contract has been fully completed |
| refund.full-initiated | Contract full refund has been initiated |
| refund.full-succeeded | Contract full refund has been succeeded |
| milestone.payment.completed | Milestone payment has been completed |
| milestone.released | Milestone has been released |
| milestone.disputed | Milestone has been disputed |
| milestone.completed | Milestone has been fully completed |
| milestone.refund.full-initiated | Milestone full refund has been initiated |
| milestone.refund.full-succeeded | Milestone full refund has been succeeded |
| dispute.created | Dispute has been created |
| dispute.resolved | Dispute has been resolved |
| webhook.test | Test webhook (sent via /webhooks/test endpoint) |