Skip to main content
POST
/
v1
/
webhooks
/
test
curl -X POST https://api.aioka.io/v1/webhooks/test \
  -H "X-API-Key: aik_basic_..." \
  -H "Content-Type: application/json" \
  -d '{"webhook_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

{
  "success": true,
  "status_code": 200,
  "message": "Test payload delivered successfully"
}

​
Overview

Fires a single test delivery to the specified webhook URL. Useful for verifying connectivity and signature validation logic before going live. Tier: Basic 🔒

​
Request

​
webhook_id
string
required
UUID of the webhook subscription to test.

​
Response

​
success
boolean
Whether the delivery received a 2xx HTTP response.
​
status_code
integer
HTTP status code from your endpoint. null if the request failed to connect.
​
message
string
Human-readable delivery result.
curl -X POST https://api.aioka.io/v1/webhooks/test \
  -H "X-API-Key: aik_basic_..." \
  -H "Content-Type: application/json" \
  -d '{"webhook_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

{
  "success": true,
  "status_code": 200,
  "message": "Test payload delivered successfully"
}