Endpoints

Webhooks

A webhook is the registry record of a subscription — a saved match condition (ticker, signal, or scan) paired with an HTTPS target. On the cadence configured for your plan, we evaluate the condition and POST a webhook.fired event when new tickers enter the match set. Subscribing does NOT auto-fire anything at your endpoint — validate your receiver any time with Test fire, which sends a real-shape webhook.fired POST synchronously. Deliver to an HTTPS endpoint or a Discord channel. See State-change dedup for why one breakout doesn’t fire 500 times. Hobby and above.

Where subscriptions are created

You don’t POST /v2/webhooks — you subscribe on the resource you want to watch. Each subscription creates a webhook record, which then shows up under this registry for management.

POST /v2/tickers/{ticker}/subscribe — Subscribe to a ticker
POST /v2/signals/{signal}/subscribe — Subscribe to a signal
POST /v2/scan/subscribe — Subscribe a scan query

Validate your receiver

Every subscribe response includes a test_url pointing at POST /v2/webhooks/{id}/test. That endpoint fires a real-shape webhook.fired POST to your target_url synchronously — same field set, same signing, same headers as a real fire. The only difference is an X-Tickerbot-Test: true header (the body is byte-identical), so tools that introspect payload shape (n8n, Zapier, custom field mappers) lock the right schema on the first delivery.

Manage subscriptions via the registry

Every endpoint below operates on the webhook record returned when you subscribed. Use the registry to list, inspect, audit deliveries, re-enable after auto-suspension, and delete.

Method	Path	Summary
GET	`https://api.tickerbot.io/v2/webhooks`	List every webhook subscription on this account.
GET	`https://api.tickerbot.io/v2/webhooks/{id}`	Fetch one webhook subscription.
DELETE	`https://api.tickerbot.io/v2/webhooks/{id}`	Delete a webhook subscription.
GET	`https://api.tickerbot.io/v2/webhooks/{id}/deliveries`	Inspect recent deliveries for a webhook.
POST	`https://api.tickerbot.io/v2/webhooks/{id}/enable`	Re-enable a disabled webhook.
POST	`https://api.tickerbot.io/v2/webhooks/{id}/test`	Send a real-shape `webhook.fired` POST to your endpoint, instantly.