- REST reference
- Account
- Webhooks
Send a test delivery
POST/public/v1/webhooks/{webhook_id}/test
Queue one signed test payload ({"event": "test", …}) to the subscription’s URL. This is the only delivery TradeEasy sends today.
PremiumAnnualLifetime
Test deliveries only today. Subscriptions can be created, edited and tested, but no live events are sent yet. The event names are reserved for when live delivery starts.
Request
curl -X POST "https://api.tradeeasyai.net/public/v1/webhooks/<webhook_id>/test" \
-H "X-API-Key: $TRADEEASY_API_KEY"Response shape
Field names and types; no sample values.
200 · application/json
{
"success": true,
"data": {
…
},
"meta": { "timestamp": "<string>", "request_id": "<string>" }
}Parameters#
- webhook_idstring · UUIDpathRequired
The subscription id.
Response fields#
- sent · webhook_id · urlboolean · string
The delivery was queued; it runs in the background with retries.
Errors#
- 400INVALID_ID
Not a UUID.
- 401detail
Missing, invalid or revoked key, or a locked account. FastAPI {"detail": …} body, not the envelope.
- 403detail
The plan does not include the REST API, or the subscription is not active.
- 404NOT_FOUND
No subscription of yours has that id.
- 429RATE_LIMIT_EXCEEDED
Per-key minute or day bucket spent. Honour Retry-After.
- 500DELIVERY_FAILED
The delivery could not be queued.