Sign in

v1

latestOpenAPI 3.0.32026-07-2618073.2 KB
Webhooks

Test webhook endpoint

Sends a test webhook to the specified URL and returns the result.

Use case. Verify your webhook endpoint is correctly configured before using it in production.

Payload types:

  • success - simulates successful code retrieval with verification data
  • failed - simulates failed code retrieval with error message

Your endpoint must return HTTP 200 to indicate successful receipt.

Testing tool. Use https://webhook.site to get a temporary URL for testing.

No persistence. Test webhooks are not stored in delivery history.

post/v1/webhooks/test

Request body

urlstring uri required

Webhook endpoint URL. Must be a valid URL.

type'success' | 'failed' required

Webhook payload type to send: success or failed.

Example request

{
  "url": "https://example.com/webhooks/handler",
  "type": "success"
}

Response

Result of webhook test request.

successboolean required

Whether the webhook was delivered successfully (HTTP 200).

http_codeinteger

HTTP status code returned by your endpoint.

response_time_msinteger

Response time in milliseconds.

response_bodystring

Response body from your endpoint (truncated to 1000 characters).

errorstring

Error message if delivery failed.

Example response

{
  "success": true,
  "http_code": 200,
  "response_time_ms": 150,
  "response_body": "OK"
}