Hooks API
Manage webhook destinations, view events, and replay missed notifications.
Destination
List Destinations
GET /api/v1/hook/destination
List all registered webhook destinations.
Create Destination
POST /api/v1/hook/destination
Register a new webhook endpoint.
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | HTTPS endpoint URL |
events | string[] | Yes | Event patterns to subscribe to |
description | string | No | Description for this destination |
secret | string | No | Shared secret for HMAC signature |
Example:
{
"url": "https://yourserver.com/webhooks/wickiepay",
"events": ["payment.*", "channel.payment.*"],
"description": "Production webhook endpoint"
}
Update Destination
PUT /api/v1/hook/destination/{id}
Full update of a webhook destination.
Patch Destination
PATCH /api/v1/hook/destination/{id}
Partial update of a webhook destination.
Remove Destination
DELETE /api/v1/hook/destination/{id}
List Destinations for Account
GET /api/v1/hook/destination/account
List webhook destinations for a specific account context.
Event
List Events
GET /api/v1/hook/event
List all webhook events that have been generated.
| Query | Type | Description |
|---|---|---|
destinationId | UUID | Filter by destination |
eventType | string | Filter by event type |
status | string | DELIVERED, FAILED, PENDING |
fromDate | ISO 8601 | Start date |
toDate | ISO 8601 | End date |
offset | number | Pagination offset |
limit | number | Page size |
Replay
Replay Events
POST /api/v1/hook/replay
Re-send one or more webhook events.
| Field | Type | Required | Description |
|---|---|---|---|
eventIds | UUID[] | Yes | List of event IDs to replay |
Event Patterns
Use wildcards to subscribe to event categories:
| Pattern | Events |
|---|---|
payment.* | All payment events |
channel.payment.* | All channel payment events |
deposit.* | All deposit events |
withdrawal.* | All withdrawal events |
trade.* | All trade/conversion events |
balance.* | Balance update events |
approval.* | Approval events |
audit.* | Audit log events |
* | All events |