curl "https://api.swiftpay.cx/api/webhooks/events?limit=10" \
-H "Authorization: Bearer mp_live_your_api_key"
const response = await fetch(
"https://api.swiftpay.cx/api/webhooks/events?limit=10",
{
headers: {
Authorization: "Bearer mp_live_your_api_key",
},
},
);
const result = await response.json();
result.data.events.forEach((event) => {
console.log(`${event.type} (${event.id})`);
event.deliveries.forEach((delivery) => {
console.log(` -> ${delivery.endpointUrl}: ${delivery.status}`);
});
});
import requests
response = requests.get(
'https://api.swiftpay.cx/api/webhooks/events',
headers={'Authorization': 'Bearer mp_live_your_api_key'},
params={'limit': 10}
)
events = response.json()['data']['events']
for event in events:
print(f"{event['type']} ({event['id']})")
for delivery in event['deliveries']:
print(f" -> {delivery['endpointUrl']}: {delivery['status']}")
{
"success": true,
"data": {
"events": [
{
"id": "evt_abc123",
"eventId": "sess_xyz789",
"type": "checkout.succeeded",
"created": 1640995200,
"data": {
"id": "sess_xyz789",
"amount": 10000,
"currency": "USD"
},
"createdAt": "2024-01-15T10:30:00Z",
"deliveries": [
{
"id": "del_123",
"endpointId": "wh_abc123",
"endpointUrl": "https://yoursite.com/webhooks",
"status": "success",
"attemptCount": 1,
"maxAttempts": 5,
"responseStatusCode": 200,
"responseBody": "OK",
"errorMessage": null,
"createdAt": "2024-01-15T10:30:01Z",
"lastAttemptAt": "2024-01-15T10:30:01Z",
"nextRetryAt": null
}
]
}
]
}
}
Webhooks
List Webhook Events
List webhook event delivery history
GET
/
api
/
webhooks
/
events
curl "https://api.swiftpay.cx/api/webhooks/events?limit=10" \
-H "Authorization: Bearer mp_live_your_api_key"
const response = await fetch(
"https://api.swiftpay.cx/api/webhooks/events?limit=10",
{
headers: {
Authorization: "Bearer mp_live_your_api_key",
},
},
);
const result = await response.json();
result.data.events.forEach((event) => {
console.log(`${event.type} (${event.id})`);
event.deliveries.forEach((delivery) => {
console.log(` -> ${delivery.endpointUrl}: ${delivery.status}`);
});
});
import requests
response = requests.get(
'https://api.swiftpay.cx/api/webhooks/events',
headers={'Authorization': 'Bearer mp_live_your_api_key'},
params={'limit': 10}
)
events = response.json()['data']['events']
for event in events:
print(f"{event['type']} ({event['id']})")
for delivery in event['deliveries']:
print(f" -> {delivery['endpointUrl']}: {delivery['status']}")
{
"success": true,
"data": {
"events": [
{
"id": "evt_abc123",
"eventId": "sess_xyz789",
"type": "checkout.succeeded",
"created": 1640995200,
"data": {
"id": "sess_xyz789",
"amount": 10000,
"currency": "USD"
},
"createdAt": "2024-01-15T10:30:00Z",
"deliveries": [
{
"id": "del_123",
"endpointId": "wh_abc123",
"endpointUrl": "https://yoursite.com/webhooks",
"status": "success",
"attemptCount": 1,
"maxAttempts": 5,
"responseStatusCode": 200,
"responseBody": "OK",
"errorMessage": null,
"createdAt": "2024-01-15T10:30:01Z",
"lastAttemptAt": "2024-01-15T10:30:01Z",
"nextRetryAt": null
}
]
}
]
}
}
List Webhook Events
Returns a list of recent webhook events that have been delivered or attempted.Request
Bearer token with your API key
Number of results to return (1-100)
Response
Whether the request was successful
Show properties
Show properties
Array of webhook event objects
Show event object
Show event object
Unique event identifier
External event ID (e.g. payment ID)
Type of event (e.g.,
checkout.succeeded, refund.completed)Event payload data
ISO 8601 creation timestamp
History of delivery attempts for this event
Show delivery object
Show delivery object
Unique delivery identifier
Target endpoint ID
Target endpoint URL
Delivery status:
pending, success, failedNumber of attempts made
Maximum number of retry attempts
HTTP status code from your server
Response body from your server
Error message if delivery failed
ISO 8601 creation timestamp
ISO 8601 timestamp of last attempt
ISO 8601 timestamp of next scheduled retry
curl "https://api.swiftpay.cx/api/webhooks/events?limit=10" \
-H "Authorization: Bearer mp_live_your_api_key"
const response = await fetch(
"https://api.swiftpay.cx/api/webhooks/events?limit=10",
{
headers: {
Authorization: "Bearer mp_live_your_api_key",
},
},
);
const result = await response.json();
result.data.events.forEach((event) => {
console.log(`${event.type} (${event.id})`);
event.deliveries.forEach((delivery) => {
console.log(` -> ${delivery.endpointUrl}: ${delivery.status}`);
});
});
import requests
response = requests.get(
'https://api.swiftpay.cx/api/webhooks/events',
headers={'Authorization': 'Bearer mp_live_your_api_key'},
params={'limit': 10}
)
events = response.json()['data']['events']
for event in events:
print(f"{event['type']} ({event['id']})")
for delivery in event['deliveries']:
print(f" -> {delivery['endpointUrl']}: {delivery['status']}")
{
"success": true,
"data": {
"events": [
{
"id": "evt_abc123",
"eventId": "sess_xyz789",
"type": "checkout.succeeded",
"created": 1640995200,
"data": {
"id": "sess_xyz789",
"amount": 10000,
"currency": "USD"
},
"createdAt": "2024-01-15T10:30:00Z",
"deliveries": [
{
"id": "del_123",
"endpointId": "wh_abc123",
"endpointUrl": "https://yoursite.com/webhooks",
"status": "success",
"attemptCount": 1,
"maxAttempts": 5,
"responseStatusCode": 200,
"responseBody": "OK",
"errorMessage": null,
"createdAt": "2024-01-15T10:30:01Z",
"lastAttemptAt": "2024-01-15T10:30:01Z",
"nextRetryAt": null
}
]
}
]
}
}
Event Statuses
| Status | Description |
|---|---|
pending | Event queued for delivery |
success | Successfully delivered (received 2xx response) |
failed | All retry attempts exhausted |
⌘I