tickerbot_subscribe_events
Subscribe to real-time market events like dividends, splits, and analyst actions. Set custom filters on ticker state and event content to receive targeted webhook notifications.
Instructions
Create an event-trigger webhook: fires when NEW events land — dividends, splits, insider filings, analyst actions ("every split in my universe", "Goldman downgrades on large caps"). TWO composable filters: q filters the event's TICKER STATE (market_cap > 1e10); event_q filters the EVENT CONTENT in the /v2/events grammar (payload->>'firm' = 'Goldman Sachs'). Paid plans (webhook slots). Deliveries carry event: "events.fired" with an events array. Latency = ingest cadence: analyst ≤1h, corporate kinds daily — NOT sub-minute like state webhooks.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional row-STATE filter evaluated against the event's ticker at fire time, e.g. market_cap > 1e10. | |
| name | No | Display name. | |
| kinds | Yes | Comma list of kinds to fire on — any of: dividend, split, insider, analyst (e.g. "split,analyst"). NOTE: no enum here on purpose — a scalar enum would reject multi-kind values. | |
| channel | No | Delivery channel. | |
| event_q | No | Optional event-CONTENT filter over (ticker, ts, kind, payload jsonb) — only those four identifiers, e.g. payload->>'firm' = 'Goldman Sachs' AND payload->>'action' = 'downgrades'. | |
| tickers | No | Scope to specific tickers (comma list, max 50). Mutually exclusive with universe; omit both for all tickers. | |
| universe | No | Scope to a universe slug (top_10, top_100, or a saved one). | |
| device_id | No | Registered device id from the mobile app (channel mobile_push). | |
| target_url | No | HTTPS delivery URL. Omit for in-app delivery. | |
| discord_url | No | Discord incoming-webhook URL (channel discord). |