Skip to main content
POST
/
api
/
v1
/
webhooks
/
test
curl -X POST https://api.settlx.io/api/v1/webhooks/test \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://yoursite.com/webhooks/settlx",
    "eventType": "invoice.settled"
  }'

{
  "data": {
    "success": true,
    "statusCode": 200,
    "eventId": "evt_test_1776195221216",
    "message": "Test webhook delivered successfully"
  }
}

​
Test Webhook

Sends a test webhook to a specified URL. Use this to verify your webhook endpoint is reachable, correctly processes the payload, and returns a 2xx HTTP status.
Test webhooks are sent ad-hoc and do not appear in the dashboard’s “Webhook Logs” view. They also use a placeholder payload with mock invoice/payment/settlement data — the values are not real. Use this endpoint to validate your signature verification and routing logic, then test the real payload shapes by paying a small invoice on a low-fee chain.

​
Request Body

​
webhookUrl
string
required
The URL to send the test webhook to. Must be a valid HTTPS URI.
​
eventType
string
default:"invoice.settled"
The event type to simulate. If omitted, an invoice.settled test event is sent.Available options: invoice.confirmed, invoice.settled, invoice.expired, invoice.overpaid, invoice.underpaid

​
Response

​
data
object
curl -X POST https://api.settlx.io/api/v1/webhooks/test \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://yoursite.com/webhooks/settlx",
    "eventType": "invoice.settled"
  }'

{
  "data": {
    "success": true,
    "statusCode": 200,
    "eventId": "evt_test_1776195221216",
    "message": "Test webhook delivered successfully"
  }
}