tickerbot.io

Get a webhook

GEThttps://api.tickerbot.io/v2/webhooks/{webhook}

Returns one webhook's current state.

stringrequired

Webhook id, from a subscribe or from List webhooks.

as_ofstring

Server time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).

idstring

The webhook id (wh_…), the handle for every other call on this record.

namestring

Your label for the subscription.

qstring

The stored predicate. Custom signals appear expanded: the SQL is frozen at creation. On an event webhook, the whole filter (the event's fields and the ticker's signals); null when it fires on every event. On a news webhook, the Query news q, or null.

selectstring[]

The signals each delivered match carries, after ticker; null means the scan default row plus the signals the rule uses in q and order. On a news webhook, the article fields each delivered article carries.

orderstring

Sort signal for each delivery's match lists: market_cap unless you chose one, so a broad alert lists the same top 100 names each time. null on event and news webhooks.

dirstringenum

Sort direction for those lists: desc unless you chose one. null on event and news webhooks.

ascAscending: smallest or earliest first.
descDescending: largest or most recent first.
universestring

Universe the trigger is scoped to, or null for the whole market.

cadencestringenum

Scan, ticker and signal webhooks only: how often the trigger is evaluated. Event and news webhooks fire as rows land.

realtimeChecked each time the data refreshes: about once a minute from 4 AM to 8 PM ET for stocks and ETFs, every minute around the clock for crypto and FX, and as each event lands for event webhooks. Fires when a ticker starts matching. The default.
hourlyChecked once an hour.
nyse_openChecked once a day, at the 9:30 AM ET open, on NYSE trading days.
channelstringenum

Where deliveries go.

webhookPOST the payload to an HTTPS endpoint you own, signed with X-Tickerbot-Signature.
discordPost to a Discord channel via its webhook URL. Delivered as a Discord embed, never HMAC-signed: the URL is itself the credential.
in_appDeliver to the in-app feed. No external receiver, so nothing to validate and no test_url.
mobile_pushPush to a registered device. Requires a device_id from Register a device.
target_urlstring

Your HTTPS endpoint; null on every channel except webhook.

statusstringenum

Whether it is live. disabled_reason says why a webhook is disabled.

activeThe subscription is live and being evaluated.
disabledTurned off; disabled_reason says why. user_disabled: you turned it off. delivery_failure: deliveries kept failing for 72 hours with none getting through. evaluation_failure: its rule can no longer run, such as when a signal it reads was removed or its universe was deleted. plan_downgrade: the account moved to a plan with fewer webhooks, and the newest beyond the new limit were turned off. subscription_canceled: the paid subscription ended. Turn it back on with PATCH /v2/webhooks/{webhook} and enabled: true.
subscription_originobject

Which subscribe route created it: type (ticker/signal/scan/event/news), its ref and the condition in display form.

created_atnumber

Creation timestamp (epoch seconds).

updated_atnumber

Last modification timestamp (epoch seconds).

last_firednumber

When a delivery last went out (epoch seconds); null if it never has.

last_match_setarray

Scan, ticker and signal webhooks only: tickers matching at the last evaluation, the set the next run is diffed against, which is what makes firing edge-triggered.

last_eval_error_atnumber

When the last evaluation error happened (epoch seconds); null on a healthy hook.

last_errorstring

The last evaluation error; null on a healthy hook. The answer to "why is my webhook not firing?".

next_eval_atnumber

When the evaluator will next consider this subscription (epoch seconds).

last_evaluated_atnumber

Scan, ticker and signal webhooks only: when it was last evaluated (epoch seconds); null until the first run.

kindstring[]enum

Event webhooks only: the kinds subscribed.

earningsFires on each quarterly earnings report: reported vs estimated EPS and the surprise.
filingFires when a 10-K, 20-F, 40-F or 10-Q lands, from the next morning’s EDGAR index read.
dividendFires on each cash-dividend declaration.
splitFires on each stock split or reverse split.
insiderFires on each reported Form 4 transaction by an officer or director.
analystFires on each upgrade, downgrade, initiation or price-target change.
estimate_revisionFires when the nightly consensus refresh moves an EPS estimate, one event per fiscal period and horizon that moved (about 1,000 a night across the market).
tickerarray

Event and news webhooks only: the symbols it is scoped to, or null for the universe or the whole market.

searchstring

News webhooks only: the full-text search it fires on, or null.

min_relevancenumber

News webhooks only: the least relevance a scoped ticker needs, or null.

consecutive_failuresnumber

Deliveries in a row that failed after the full retry ladder; resets on any success. Informational: a webhook is disabled when deliveries have kept failing for 72 hours (since failing_since) with none getting through, not on a count.

last_success_atnumber

When a delivery last reached your endpoint, in epoch seconds (created_at until the first one does).

failing_sincenumber

When the current failure streak began (epoch seconds); null while deliveries are succeeding.

channel_config_presentboolean

Discord and mobile-push webhooks: true when delivery settings are stored. The Discord URL itself is never returned after create.

disabled_reasonstringenum

Disabled webhooks only: why it was turned off. Turn it back on with PATCH /v2/webhooks/{webhook} and enabled: true.

user_disabledYou turned it off.
delivery_failureDeliveries kept failing for 72 hours with none getting through.
evaluation_failureIts rule can no longer run, for example because a signal it names was renamed or its universe was deleted. disabled_explanation says what changed.
plan_downgradeYour webhook limit went down, and the newest webhooks over the new limit were turned off.
subscription_canceledYour paid subscription ended.
disabled_last_status_codenumber

After a delivery_failure: the HTTP status your endpoint last returned.

disabled_last_errorstring

After a delivery_failure or evaluation_failure: the error that disabled it; null when your endpoint answered with an HTTP status (see disabled_last_status_code).

disabled_explanationstring

After an evaluation_failure: what changed and what to use instead, for example the new name of a renamed signal.

disabled_atnumber

After an evaluation_failure, plan_downgrade or subscription_canceled: when it was disabled (epoch seconds).

disable_email_sent_atnumber

When we emailed you about the disable (epoch seconds).

channel_configobject

Mobile-push webhooks only: { device_id }, the device deliveries go to.

CodeMeaning
200The full webhook record (signing_secret stripped).
400Invalid webhook id format.
404Webhook not found, or owned by another account.
  • Visibility is account-scoped, not key-scoped: every API key on this account can fetch every webhook on it. A webhook owned by a different account returns 404.