View as markdown
Endpoints · Webhooks

Create a subscription

POST/v2/webhooks

Register a SQL WHERE clause (inline `q` or `rule_id`) + an HTTPS target URL. On the cadence configured for your plan, we evaluate the clause against the relevant ticker universe. When a new ticker enters the match set, we POST a `webhook.fired` event to your target. On creation we also send a one-shot `webhook.ping` to verify reachability; the subscription stays in `pending_verification` until the ping returns a 2xx response, then flips to `active`.

Plan access

Included on every plan.

Cadence

Hobby 5m · Pro 1m · Scale 1m · Enterprise 1m.

Capacity

Hobby 5 · Pro 25 · Scale 100 · Enterprise unlimited.

Status codes

201
Webhook created. The response is the full doc, including the one-time signing_secret you'll use to verify deliveries. Save it; it's never returned again.
400
Missing parameter, oversized parameter, non-HTTPS URL, or both q and rule_id supplied.
401
Missing or invalid API key.
402
Query references a premium signal and your plan does not include premium signals.
403
webhook_tier_required (free), webhook_limit_reached (over plan cap), or cadence_above_plan_max.
404
rule_not_found when the referenced rule_id does not exist.