API ReferenceWebhooks
Webhooks
Register and manage webhook endpoints for real-time event notifications.
POST
/v1/webhooks/endpointsCreate a webhook endpoint
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
url | string | body | Required | HTTPS URL to receive events |
events | string[] | body | Required | List of event types to subscribe to |
description | string | body | Optional | Endpoint description |
Response Codes
201Endpoint created400Invalid URL or events
1{
2 "id": "wh_ep_abc123",
3 "object": "webhook_endpoint",
4 "url": "https://api.yourapp.com/webhooks/wyrr",
5 "events": ["payment.succeeded", "payment.failed", "payout.completed"],
6 "secret": "whsec_abc123xyz...",
7 "status": "active",
8 "created_at": "2026-05-01T12:00:00Z"
9}
GET
/v1/webhooks/endpointsList all webhook endpoints
Response Codes
200Endpoints listed
1{
2 "object": "list",
3 "data": [
4 {
5 "id": "wh_ep_abc123",
6 "url": "https://api.yourapp.com/webhooks/wyrr",
7 "events": ["payment.succeeded", "payment.failed"],
8 "status": "active"
9 }
10 ]
11}
DELETE
/v1/webhooks/endpoints/{id}Delete a webhook endpoint
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id | string | path | Required | Endpoint ID |
Response Codes
204Endpoint deleted404Endpoint not found
1// 204 No Content