tickerbot_update_webhook
Edit an existing webhook in place by sending only the fields you want to change, validating new filters like a subscription and firing only on new matches.
Instructions
Edits a webhook in place; send only the fields you want to change. The trigger takes the filters of the subscribe that made the webhook (subscription_origin.type: scan q/universe/select/order/dir; ticker q/select; signal condition/universe/select/order/dir; event kind/ticker/universe/q/select; news search/ticker/universe/min_relevance/q/select), validated like a new subscribe; a change to the filters fires only on new matches (what already matches or already happened does not fire), while an edit of select/order/dir keeps what already matched. enabled=true turns a disabled webhook back on. Unknown fields are a 400.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"webhook": "<webhook>"
},
"name": "tickerbot_update_webhook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Only with scan, ticker, event or news webhooks. The filter, in the grammar of the subscribe that made the webhook. On an event webhook it replaces the whole filter. On a ticker webhook send the condition alone, or the `q` a read returns (`ticker = 'NVDA' AND (…)`): the webhook's own ticker scope is not added twice. A change to the filters (`q`, `condition`, `universe`, `kind`, `ticker`, `search`, `min_relevance`) fires only on new matches; an edit of `select`, `order` or `dir` keeps what already matched. | |
| dir | No | Only with scan or signal webhooks. The sort direction for `order`. Values: asc: Ascending: smallest or earliest first. desc: Descending: largest or most recent first. | |
| kind | No | Only with event webhooks. The kinds to fire on, as on Subscribe to events. Values: earnings: Fires on each quarterly earnings report: reported vs estimated EPS and the surprise. dividend: Fires on each cash-dividend declaration. split: Fires on each stock split or reverse split. filing: Fires when a 10-K, 20-F, 40-F or 10-Q lands, from the next morning’s EDGAR index read. insider: Fires on each reported Form 4 transaction by an officer or director. analyst: Fires on each upgrade, downgrade, initiation or price-target change. estimate_revision: Fires 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). | |
| name | No | New display name. Non-empty, max 80 characters. | |
| order | No | Only with scan or signal webhooks. The signal each delivery's match lists are sorted by. | |
| search | No | Only with news webhooks. The full-text search, as on Subscribe to news. | |
| select | No | What each delivery carries, as on the subscribe that made the webhook; `null` for the default. | |
| ticker | No | Only with event or news webhooks. The symbols, one or a comma list. Replaces a `universe` scope. | |
| cadence | No | Evaluation cadence. Event and news webhooks deliver as they land, so only `realtime` is accepted on them. Values: realtime: Checked 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. hourly: Checked once an hour. nyse_open: Checked once a day, at the 9:30 AM ET open, on NYSE trading days. | |
| channel | No | Moves the webhook to another channel: `webhook` (with `target_url`), `discord` (with `discord_url`), `in_app` or `mobile_push` (with `device_id`). Inferred from `discord_url` or `device_id` when you send one of those alone. Values: webhook: POST the payload to an HTTPS endpoint you own, signed with `X-Tickerbot-Signature`. discord: Post to a Discord channel via its webhook URL. Delivered as a Discord embed, never HMAC-signed: the URL is itself the credential. in_app: Deliver to the in-app feed. No external receiver, so nothing to validate and no `test_url`. mobile_push: Push to a registered device. Requires a `device_id` from Register a device. | |
| enabled | No | `false` turns the webhook off. `true` turns a disabled webhook back on: your webhook limit is checked and the trigger is checked again. A plain re-enable starts clean and fires once for every current match; after a change to the trigger's filters (in this call or while it was off) it fires only on new matches. | |
| webhook | Yes | Webhook id. | |
| universe | No | Only with scan, signal, event or news webhooks. The universe to scope to; `null` for the whole market. On event and news webhooks it replaces a `ticker` scope. | |
| condition | No | Only with signal webhooks. The bound, in Get a signal's grammar (`<30`). | |
| device_id | No | Only with `channel=mobile_push`. Device to notify, from `POST /v2/devices/register`. | |
| target_url | No | New https:// delivery URL. Alone, it moves a webhook between HTTPS (`target_url`) and in-app delivery (`null` or empty); a Discord or mobile-push webhook sends `channel: "webhook"` with it. | |
| discord_url | No | Only with `channel=discord`. Discord incoming-webhook URL. Never returned after this call: reads show `channel_config_present: true`. | |
| min_relevance | No | Only with news webhooks. The least relevance (0–1) a scoped ticker needs; the webhook needs a `ticker` or `universe` scope. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | 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`. | |
| id | Yes | The webhook id (`wh_…`), the handle for every other call on this record. | |
| dir | Yes | Sort direction for those lists: `desc` unless you chose one. `null` on event and news webhooks. One of: `asc`, `desc`. | |
| kind | No | Event webhooks only: the kinds subscribed. One of: `earnings`, `filing`, `dividend`, `split`, `insider`, `analyst`, `estimate_revision`. | |
| name | Yes | Your label for the subscription. | |
| _meta | No | Only when a new trigger named a signal under its pre-2026-09-07 spelling: `deprecated_signals` lists each one (`requested`, `use`, `note`). The stored rule carries the current name. | |
| as_of | Yes | Server time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of). | |
| order | Yes | 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. | |
| search | No | News webhooks only: the full-text search it fires on, or `null`. | |
| select | Yes | 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. | |
| status | Yes | Whether it is live. `disabled_reason` says why a webhook is disabled. One of: `active`, `disabled`. | |
| ticker | No | Event and news webhooks only: the symbols it is scoped to, or `null` for the universe or the whole market. | |
| cadence | No | Scan, ticker and signal webhooks only: how often the trigger is evaluated. Event and news webhooks fire as rows land. One of: `realtime`, `hourly`, `nyse_open`. | |
| channel | Yes | Where deliveries go. One of: `webhook`, `discord`, `in_app`, `mobile_push`. | |
| universe | Yes | Universe the trigger is scoped to, or `null` for the whole market. | |
| created_at | Yes | Creation timestamp (epoch seconds). | |
| last_error | No | The last evaluation error; `null` on a healthy hook. The answer to "why is my webhook not firing?". | |
| last_fired | Yes | When a delivery last went out (epoch seconds); `null` if it never has. | |
| target_url | Yes | Your HTTPS endpoint; `null` on every channel except `webhook`. | |
| updated_at | Yes | Last modification timestamp (epoch seconds). | |
| _advisories | No | Present only when the response carried a warning: `deprecated` (since, sunset_on, successor, warning; on a deprecated tool, successor names the tool to call), `rate_limit` (warning, retry_after_seconds, limit, remaining, reset_epoch_s) or `monthly_quota` (warning, limit, remaining, reset_epoch_s). | |
| disabled_at | No | After an `evaluation_failure`, `plan_downgrade` or `subscription_canceled`: when it was disabled (epoch seconds). | |
| next_eval_at | No | When the evaluator will next consider this subscription (epoch seconds). | |
| failing_since | No | When the current failure streak began (epoch seconds); `null` while deliveries are succeeding. | |
| min_relevance | No | News webhooks only: the least `relevance` a scoped ticker needs, or `null`. | |
| channel_config | No | Mobile-push webhooks only: `{ device_id }`, the device deliveries go to. | |
| last_match_set | No | 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. | |
| disabled_reason | No | Disabled webhooks only: why it was turned off. Turn it back on with `PATCH /v2/webhooks/{webhook}` and `enabled: true`. One of: `user_disabled`, `delivery_failure`, `evaluation_failure`, `plan_downgrade`, `subscription_canceled`. | |
| last_success_at | No | When a delivery last reached your endpoint, in epoch seconds (`created_at` until the first one does). | |
| last_evaluated_at | No | Scan, ticker and signal webhooks only: when it was last evaluated (epoch seconds); `null` until the first run. | |
| last_eval_error_at | No | When the last evaluation error happened (epoch seconds); `null` on a healthy hook. | |
| disabled_last_error | No | 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`). | |
| subscription_origin | Yes | Which subscribe route created it: `type` (`ticker`/`signal`/`scan`/`event`/`news`), its `ref` and the `condition` in display form. | |
| consecutive_failures | No | 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. | |
| disabled_explanation | No | After an `evaluation_failure`: what changed and what to use instead, for example the new name of a renamed signal. | |
| disable_email_sent_at | No | When we emailed you about the disable (epoch seconds). | |
| channel_config_present | No | Discord and mobile-push webhooks: `true` when delivery settings are stored. The Discord URL itself is never returned after create. | |
| disabled_last_status_code | No | After a `delivery_failure`: the HTTP status your endpoint last returned. |