Skip to main content
Glama
Tickerbot MCP Server

Tickerbot MCP Server

Official
by tickerbot

tickerbot_get_webhook

Retrieves the current state of a specific webhook by its ID, so you can check its subscription status and configuration.

Instructions

Returns one webhook's current state.

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_get_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
webhookYesWebhook id, from a subscribe or from List webhooks.

Output Schema

NameRequiredDescriptionDefault
qYesThe 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`.
idYesThe webhook id (`wh_…`), the handle for every other call on this record.
dirYesSort direction for those lists: `desc` unless you chose one. `null` on event and news webhooks. One of: `asc`, `desc`.
kindNoEvent webhooks only: the kinds subscribed. One of: `earnings`, `filing`, `dividend`, `split`, `insider`, `analyst`, `estimate_revision`.
nameYesYour label for the subscription.
as_ofYesServer time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).
orderYesSort 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.
searchNoNews webhooks only: the full-text search it fires on, or `null`.
selectYesThe 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.
statusYesWhether it is live. `disabled_reason` says why a webhook is disabled. One of: `active`, `disabled`.
tickerNoEvent and news webhooks only: the symbols it is scoped to, or `null` for the universe or the whole market.
cadenceNoScan, 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`.
channelYesWhere deliveries go. One of: `webhook`, `discord`, `in_app`, `mobile_push`.
universeYesUniverse the trigger is scoped to, or `null` for the whole market.
created_atYesCreation timestamp (epoch seconds).
last_errorNoThe last evaluation error; `null` on a healthy hook. The answer to "why is my webhook not firing?".
last_firedYesWhen a delivery last went out (epoch seconds); `null` if it never has.
target_urlYesYour HTTPS endpoint; `null` on every channel except `webhook`.
updated_atYesLast modification timestamp (epoch seconds).
_advisoriesNoPresent 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_atNoAfter an `evaluation_failure`, `plan_downgrade` or `subscription_canceled`: when it was disabled (epoch seconds).
next_eval_atNoWhen the evaluator will next consider this subscription (epoch seconds).
failing_sinceNoWhen the current failure streak began (epoch seconds); `null` while deliveries are succeeding.
min_relevanceNoNews webhooks only: the least `relevance` a scoped ticker needs, or `null`.
channel_configNoMobile-push webhooks only: `{ device_id }`, the device deliveries go to.
last_match_setNoScan, 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_reasonNoDisabled 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_atNoWhen a delivery last reached your endpoint, in epoch seconds (`created_at` until the first one does).
last_evaluated_atNoScan, ticker and signal webhooks only: when it was last evaluated (epoch seconds); `null` until the first run.
last_eval_error_atNoWhen the last evaluation error happened (epoch seconds); `null` on a healthy hook.
disabled_last_errorNoAfter 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_originYesWhich subscribe route created it: `type` (`ticker`/`signal`/`scan`/`event`/`news`), its `ref` and the `condition` in display form.
consecutive_failuresNoDeliveries 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_explanationNoAfter an `evaluation_failure`: what changed and what to use instead, for example the new name of a renamed signal.
disable_email_sent_atNoWhen we emailed you about the disable (epoch seconds).
channel_config_presentNoDiscord and mobile-push webhooks: `true` when delivery settings are stored. The Discord URL itself is never returned after create.
disabled_last_status_codeNoAfter a `delivery_failure`: the HTTP status your endpoint last returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.4.1
    • removedInput schema / properties / id
      Removed value: -{
      -  "description": "Webhook id (looks like `wh_…`).",
      -  "type": "string"
      -}
    • addedInput schema / properties / webhook
      Added value: +{
      +  "description": "Webhook id, from a subscribe or from List webhooks.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "id"
      -]New value: +[
      +  "webhook"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "_advisories": {
      +      "description": "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).",
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "as_of": {
      +      "description": "Server time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "cadence": {
      +      "description": "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`.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "channel": {
      +      "description": "Where deliveries go. One of: `webhook`, `discord`, `in_app`, `mobile_push`.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "channel_config": {
      +      "description": "Mobile-push webhooks only: `{ device_id }`, the device deliveries go to."
      +    },
      +    "channel_config_present": {
      +      "description": "Discord and mobile-push webhooks: `true` when delivery settings are stored. The Discord URL itself is never returned after create."
      +    },
      +    "consecutive_failures": {
      +      "description": "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."
      +    },
      +    "created_at": {
      +      "description": "Creation timestamp (epoch seconds).",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "dir": {
      +      "description": "Sort direction for those lists: `desc` unless you chose one. `null` on event and news webhooks. One of: `asc`, `desc`.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "disable_email_sent_at": {
      +      "description": "When we emailed you about the disable (epoch seconds)."
      +    },
      +    "disabled_at": {
      +      "description": "After an `evaluation_failure`, `plan_downgrade` or `subscription_canceled`: when it was disabled (epoch seconds)."
      +    },
      +    "disabled_explanation": {
      +      "description": "After an `evaluation_failure`: what changed and what to use instead, for example the new name of a renamed signal."
      +    },
      +    "disabled_last_error": {
      +      "description": "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_last_status_code": {
      +      "description": "After a `delivery_failure`: the HTTP status your endpoint last returned."
      +    },
      +    "disabled_reason": {
      +      "description": "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`."
      +    },
      +    "failing_since": {
      +      "description": "When the current failure streak began (epoch seconds); `null` while deliveries are succeeding."
      +    },
      +    "id": {
      +      "description": "The webhook id (`wh_…`), the handle for every other call on this record.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "kind": {
      +      "description": "Event webhooks only: the kinds subscribed. One of: `earnings`, `filing`, `dividend`, `split`, `insider`, `analyst`, `estimate_revision`."
      +    },
      +    "last_error": {
      +      "description": "The last evaluation error; `null` on a healthy hook. The answer to \"why is my webhook not firing?\"."
      +    },
      +    "last_eval_error_at": {
      +      "description": "When the last evaluation error happened (epoch seconds); `null` on a healthy hook."
      +    },
      +    "last_evaluated_at": {
      +      "description": "Scan, ticker and signal webhooks only: when it was last evaluated (epoch seconds); `null` until the first run.",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "last_fired": {
      +      "description": "When a delivery last went out (epoch seconds); `null` if it never has."
      +    },
      +    "last_match_set": {
      +      "description": "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.",
      +      "type": [
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "last_success_at": {
      +      "description": "When a delivery last reached your endpoint, in epoch seconds (`created_at` until the first one does).",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "min_relevance": {
      +      "description": "News webhooks only: the least `relevance` a scoped ticker needs, or `null`."
      +    },
      +    "name": {
      +      "description": "Your label for the subscription.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "next_eval_at": {
      +      "description": "When the evaluator will next consider this subscription (epoch seconds).",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "order": {
      +      "description": "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.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "q": {
      +      "description": "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`.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "search": {
      +      "description": "News webhooks only: the full-text search it fires on, or `null`."
      +    },
      +    "select": {
      +      "description": "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": {
      +      "description": "Whether it is live. `disabled_reason` says why a webhook is disabled. One of: `active`, `disabled`.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "subscription_origin": {
      +      "description": "Which subscribe route created it: `type` (`ticker`/`signal`/`scan`/`event`/`news`), its `ref` and the `condition` in display form.",
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "target_url": {
      +      "description": "Your HTTPS endpoint; `null` on every channel except `webhook`."
      +    },
      +    "ticker": {
      +      "description": "Event and news webhooks only: the symbols it is scoped to, or `null` for the universe or the whole market."
      +    },
      +    "universe": {
      +      "description": "Universe the trigger is scoped to, or `null` for the whole market."
      +    },
      +    "updated_at": {
      +      "description": "Last modification timestamp (epoch seconds).",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "as_of",
      +    "id",
      +    "name",
      +    "q",
      +    "select",
      +    "order",
      +    "dir",
      +    "universe",
      +    "channel",
      +    "target_url",
      +    "status",
      +    "subscription_origin",
      +    "created_at",
      +    "updated_at",
      +    "last_fired"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.2.0

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry behavioral context. It discloses that this is a read of current state, but it does not mention permissions, error behavior for an invalid id, or rate limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence with no wasted wording. It is appropriately sized for a simple single-resource retrieval tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple getter with full schema coverage and an output schema, the description is largely complete. It could still add a note about missing-webhook behavior or permissions, but return details are covered by the output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the webhook parameter is already described as a webhook id from subscribe or List webhooks. The description adds no additional parameter meaning beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource: it returns one webhook's current state. This clearly distinguishes a single-webhook read from list/update/delete siblings, but it does not explicitly mention the sibling alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by 'one webhook's current state' and by the required webhook id, but the description does not explicitly say when to use this versus list_webhooks or update_webhook.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.