Skip to main content
POST

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

string
required
The URL to send the test webhook to. Must be a valid HTTPS URI.
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

object