View as markdown
Endpoints · Webhooks

Test fire a webhook

POSThttps://api.tickerbot.io/v2/webhooks/{id}/test

Fires a real-shape webhook.fired payload to the webhook's target_url synchronously. The request body is byte-identical to a real fire — same field set, same signing, same X-Tickerbot-Signature HMAC — so tools that introspect payload shape (n8n, Zapier, custom field mappers) lock the right schema the first time. The test marker rides in an X-Tickerbot-Test: true HTTP header (not the body), so receivers that don't care get a payload indistinguishable from production, and those that do can filter on the header. Use this any time to validate endpoint reachability, payload parsing, and signature verification.

Plan access

Paid plans (Hobby and above).

Cadence

Real-time on every paid plan — evaluated on every data refresh (~1×/min), so a match is delivered within seconds of it landing. Optionally throttle a webhook to hourly or at-market-open.

Capacity

Hobby 10 · Pro 100 · Scale 1,000 · Enterprise unlimited.

Body parameters

stringrequired

Webhook id.

Status codes

202
The inline delivery outcome — delivered true/false, http_status from your endpoint, elapsed_ms for the round trip, and error (if any). One-shot: a failed test fire is recorded as permanent_failure and is NOT retried (test fires never enter the standard retry ladder, and never trigger auto-disable on the parent webhook). Call /test again to re-test after fixing your receiver.
400
The webhook has no target_url (in-app deliveries have nothing to fire over the wire).
404
Webhook not found.