- REST reference
- Account
- Webhooks
Update a webhook
PUT/public/v1/webhooks/{webhook_id}
Change the URL, the events, or pause and resume a subscription.
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 PUT "https://api.tradeeasyai.net/public/v1/webhooks/<webhook_id>" \
-H "X-API-Key: $TRADEEASY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"is_active": false}'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.
- urlstringbody
New HTTPS URL.
- eventsstring[]body
New event list, at least one.
- is_activebooleanbody
false pauses, true resumes.
Response fields#
- (object)object
The updated subscription.
Errors#
- 400INVALID_ID · INVALID_URL · INVALID_EVENTS
Bad id, URL or event name.
- 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.
- 422detail[]
A query value is outside its range (FastAPI validation).
- 429RATE_LIMIT_EXCEEDED
Per-key minute or day bucket spent. Honour Retry-After.
- 500UPDATE_FAILED
Our side. Retry with backoff.