Webhooks
Webhooks provide real-time server-to-server notifications when events occur in your WickiePay account. Use webhooks to keep your system synchronized with payment status changes, deposits, withdrawals, and more.
How Webhooks Work
Event occurs (e.g., payment complete)
↓
WickiePay sends HTTP POST to your endpoint
↓
Your server processes the event
↓
Returns 200 OK to acknowledge receipt
Setting Up Webhooks
Step 1: Create a Webhook Destination
Register your endpoint URL where WickiePay will send events.
POST /api/v1/hook/destination
Content-Type: application/json
{
"url": "https://yourserver.com/webhooks/wickiepay",
"events": ["payment.*", "channel.payment.*"],
"description": "Production webhook endpoint"
}
Step 2: Select Events
Choose which events to subscribe to. Use wildcards (*) to subscribe to all events in a category:
| Pattern | Events |
|---|---|
payment.* | All payment events |
channel.payment.* | All channel payment events |
deposit.* | All deposit events |
withdrawal.* | All withdrawal events |
* | All events |
Step 3: Implement Your Listener
See Creating a Webhook Listener for implementation details.
Webhook Delivery
| Property | Value |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Timeout | 30 seconds |
| Retries | 3 attempts with exponential backoff |
| Signature | HMAC-SHA256 in X-Webhook-Signature header |
Managing Destinations
List Destinations
GET /api/v1/hook/destination
Update Destination
PUT /api/v1/hook/destination/{id}
Content-Type: application/json
{
"url": "https://yourserver.com/webhooks/v2/wickiepay",
"events": ["payment.*"]
}
Remove Destination
DELETE /api/v1/hook/destination/{id}
Next Steps
- Event Types — All available webhook events
- Create a Listener — Implementation guide
- Event Replay — Re-send missed events