tickerbot_create_webhook

{
  "type": "object",
  "properties": {
    "trigger": {
      "type": "object",
      "description": "What fires the webhook. A discriminated object — `trigger.type` picks the shape, and the fields below belong inside it. Each shape is also available as a flat-params shortcut: `POST /v2/scan/subscribe`, `/v2/tickers/{t}/subscribe`, `/v2/signals/{s}/subscribe`, `/v2/events/subscribe`.",
      "properties": {
        "type": {
          "type": "string",
          "description": "Which trigger shape the rest of the object uses.",
          "enum": [
            "scan",
            "ticker",
            "signal",
            "event"
          ]
        },
        "q": {
          "type": "string",
          "description": "scan: required — the SQL WHERE any ticker must match to fire. ticker: required — WHERE fragment evaluated for that ticker (auto-scoped; don't add `ticker = …` yourself; `trigger.condition` accepted as an alias). event: optional row-STATE filter on the event's ticker at fire time (`market_cap > 1e10`)."
        },
        "signal": {
          "type": "string",
          "description": "signal: required — a built-in signal name (e.g. `rsi_14`) or one of your custom signals (custom SQL is expanded and frozen at creation)."
        },
        "condition": {
          "type": "string",
          "description": "signal: required for numeric signals — a single bound like `>70`; sending one with a boolean or custom signal returns 400 (it does not apply). ticker: accepted as the original alias of `trigger.q`."
        },
        "ticker": {
          "type": "string",
          "description": "ticker: required — the symbol to watch (e.g. `NVDA`). signal: optional — restrict the signal to one symbol (omit to watch the whole universe)."
        },
        "tickers": {
          "type": "string",
          "description": "event: optional symbol list, max 50 (e.g. `AAPL,NVDA`). Mutually exclusive with `trigger.universe`."
        },
        "kinds": {
          "type": "string",
          "description": "event: required — event kinds to fire on, array or comma list (e.g. `split,analyst`)."
        },
        "event_q": {
          "type": "string",
          "description": "event: optional event-CONTENT filter in the `/v2/events` grammar over `(ticker, ts, kind, payload)` — e.g. `payload->>'firm' = 'Goldman Sachs'`. Composes with `trigger.q`."
        },
        "universe": {
          "type": "string",
          "description": "scan / signal / event: optional universe slug (`top_10`, `top_100`, or one of yours) scoping which tickers can fire. Mutually exclusive with `trigger.tickers` on event."
        }
      },
      "required": [
        "type"
      ]
    },
    "target_url": {
      "type": "string",
      "description": "HTTPS delivery URL (the `webhook` channel), max 1024 characters. Omit for in-app delivery, or use `channel` + `discord_url`/`device_id` for other channels."
    },
    "channel": {
      "type": "string",
      "description": "Delivery channel. See Delivery channels.",
      "enum": [
        "webhook",
        "discord",
        "in_app",
        "mobile_push"
      ]
    },
    "discord_url": {
      "type": "string",
      "description": "Discord webhook URL (channel `discord`)."
    },
    "device_id": {
      "type": "string",
      "description": "Registered device id (channel `mobile_push`, see /v2/devices)."
    },
    "cadence": {
      "type": "string",
      "description": "Evaluation cadence — a user preference — never gated. Event triggers deliver on ingest — only `realtime` is accepted on them (400 otherwise).",
      "enum": [
        "realtime",
        "hourly",
        "nyse_open"
      ],
      "default": "realtime"
    },
    "name": {
      "type": "string",
      "description": "Display name, max 80 characters. Defaults to an auto-generated one from the trigger."
    },
    "columns": {
      "type": "string",
      "description": "Extra columns echoed in fired payloads' match rows (`fields` accepted as an alias). Not accepted on `event` triggers (400) — event deliveries carry the event payload, not state rows."
    },
    "order": {
      "type": "string",
      "description": "Signal the fired payload's match lists are sorted by before the 100-row cap is applied — so a truncated list is the deterministic top 100, not an arbitrary sample. Same contract as `POST /v2/scan`. Not accepted on `event` triggers (they deliver one event at a time).",
      "default": "market_cap"
    },
    "dir": {
      "type": "string",
      "description": "Sort direction for `order`. Not accepted on `event` triggers (400).",
      "enum": [
        "asc",
        "desc"
      ],
      "default": "desc"
    }
  },
  "required": [
    "trigger"
  ]
}