View as markdown
Endpoints · Tickers

Subscribe to a ticker

POSThttps://api.tickerbot.io/v2/tickers/{ticker}/subscribe

Subscribes a single ticker. condition is a WHERE-clause fragment evaluated when this ticker is matched — you do not need to add ticker = '…' yourself; the endpoint scopes the predicate to the path ticker automatically. Plan-gated by webhook tier; counts against your account-wide webhook cap. Returns the same shape as GET /v2/webhooks/{id}, plus a test_url pointing at POST /v2/webhooks/{id}/test — subscribing does NOT auto-fire anything at your endpoint; hit the test URL to send a real-shape webhook.fired and validate your receiver.

Custom signals referenced in condition are expanded and frozen into the webhook at creation — editing the signal later will not change this subscription (re-subscribe to apply). See Create a custom signal.

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 & Enterprise unlimited.

Body parameters

stringrequired

Ticker symbol (case-insensitive).

stringrequired

WHERE-clause fragment using signal/column names from the schema.

string

https:// URL to POST when the condition fires. Omit for in-app delivery (visible in the dashboard).

string

Delivery channel. `webhook` (POST to `target_url`), `discord` (post an embed to `discord_url`), `in_app` (dashboard only), or `mobile_push` (notify a phone signed in to the Tickerbot mobile app; requires a `device_id` from `POST /v2/devices/register`). Inferred when omitted: `webhook` if `target_url` is set, `discord` if `discord_url` is set, else `in_app`. `slack` is reserved and returns `501`. See the Delivery channels guide.

string

Discord incoming-webhook URL (`https://discord.com/api/webhooks/…`). Required when `channel` is `discord`. Stored as a posting credential and stripped from list/get responses, which set `channel_config_present: true` instead.

string

How often to evaluate. `realtime` (the default) is evaluated on every data refresh (~1×/min); `hourly` and `nyse_open` throttle to a batch schedule. `1m` is a deprecated alias for `realtime`.

string

Human-readable label (up to 80 chars). Defaults to `<TICKER>: <condition>`.

string

Comma-separated extra columns to include in each fired payload match row, beyond the standard set (`ticker`, `name`, `asset_type`, `price`, `day_change_pct`, `market_cap`). Each must be a real column; an unknown column is rejected at creation.

Status codes

200
Webhook subscription created.
400
bad_request — missing condition, invalid ticker, or malformed target_url.
403
webhook_tier_required or webhook_limit_reached.
404
not_found — ticker is not tracked.