Endpoints › Webhooks

Update a webhook

PATCHhttps://api.tickerbot.io/v2/webhooks/{id}

Edit a webhook in place — send only the fields you want to change.

Body parameters

idstringrequired

Webhook id.

namestring

New display name. Non-empty, max 80 characters.

cadenceenum

Evaluation cadence. A user preference — never gated. Event triggers deliver on ingest — only realtime is accepted on them (400 otherwise).

`realtime`	Evaluate on every refresh — the canonical value. (`1m` is a deprecated alias that collapses to this.)
`hourly`	Batch schedule: evaluate once an hour.
`nyse_open`	Batch schedule: evaluate once per session, at the NYSE open.

target_urlstring

New https:// delivery URL (webhook channel only — a Discord/mobile subscription 400s here). null or empty switches to in-app delivery; status is untouched — a disabled webhook stays disabled until POST /v2/webhooks/{id}/enable (the only path that re-checks your account's webhook cap).

enabledboolean

false disables the webhook (status → disabled). true is a no-op unless disabled, in which case use POST /v2/webhooks/{id}/enable instead.

Returns

as_ofstring

Server time this response was assembled (ISO 8601).

idstring

The webhook id — `wh_…`, the handle for every other call on this record.

namestring

Your label for the subscription.

qstring

The stored predicate. Custom signals appear expanded: the SQL is frozen at creation.

rule_idstring

Legacy link to a v1 alert rule; `null` on everything created through v2.

fieldsstring

Extra signals carried on each fired match row; `null` means the standard set.

orderstring

Sort signal for the payload row list; `null` means the evaluator default (`market_cap`).

dirstring

Sort direction for that list; `null` means the default (`desc`).

universe_idstring

Universe the trigger is scoped to, or `null` for the whole market.

cadencestring

How often the trigger is evaluated — `realtime`, `hourly`, or `nyse_open`.

channelstring

Where deliveries go: `webhook`, `discord`, `in_app`, or `mobile_push`.

target_urlstring

Your HTTPS endpoint; `null` on every channel except `webhook`.

deliverystring

Legacy alias of `channel`, kept aligned for older readers.

statusstring

`active` or `disabled`. Auto-disable follows repeated delivery failure.

sourcestring

Which API version created the record; `v2` for anything you create today.

subscription_originobject

Which door created it — `type` (`ticker`/`signal`/`scan`/`event`), its `ref`, and the `condition` in display form.

last_predicate_valuestring

The trigger's value at the last evaluation; `null` until it has run.

created_atnumber

Creation timestamp.

updated_atnumber

Last modification timestamp.

last_firednumber

When a delivery last went out; `null` if it never has.

last_match_setarray

Tickers matching at the last evaluation — the set the next run is diffed against, which is what makes firing edge-triggered.

last_eval_error_atnumber

When the last evaluation error happened; `null` on a healthy hook.

last_errorstring

The last evaluation error; `null` on a healthy hook. The answer to "why is my webhook not firing?".

next_eval_atnumber

When the evaluator will next consider this subscription.

last_evaluated_atnumber

When it was last evaluated; `null` until the first run.

event_kindsarray

Event-trigger webhooks only: the kinds subscribed (`split`, `dividend`, `insider`, `analyst`, `earnings`).

event_qstring

Event-trigger webhooks only: the payload filter, or `null`.

event_tickersarray

Event-trigger webhooks only: the symbols the trigger is scoped to, or `null` for the universe / whole market.

trigger_kindstring

Event-trigger webhooks only: `event`.

Status codes

200

The updated webhook record (signing_secret stripped). An empty patch body returns the current record unchanged.

400

Invalid id format, bad field value, an unknown/immutable field in the body (strict — unknown keys are rejected, not ignored), target_url on a non-webhook channel, or enabled: true on a disabled webhook.

404

Webhook not found, or owned by another account.

Notes

Editable: name, cadence, target_url, enabled. The trigger itself (q/ticker/signal/universe scope) and the channel are immutable after creation — to change what fires, or where a Discord/mobile subscription delivers, delete and re-subscribe.
Changing target_url does NOT re-validate the endpoint; there is no handshake, so confirm delivery with POST /v2/webhooks/{id}/test. Setting it to null or "" switches delivery to in-app and leaves status untouched, so a disabled webhook stays disabled.
enabled: false disables the webhook. Re-enabling routes through POST /v2/webhooks/{id}/enable, which re-checks your account's webhook cap — so enabled: true on a disabled webhook is a 400 pointing there.
After changing target_url, fire POST /v2/webhooks/{id}/test to verify the new endpoint receives and verifies a signed delivery.

curl -X PATCH "https://api.tickerbot.io/v2/webhooks/wh_smRsF3-z36o" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "RSI + volume",
    "target_url": "https://example.com/hook",
    "enabled": false
  }'

Sample response

{
  "as_of": "2026-07-27T14:02:11.000Z",
  "id": "wh_smRsF3-z36o",
  "name": "NVDA · gap_up AND high_volume_alert",
  "q": "ticker = 'NVDA' AND (gap_up AND high_volume_alert)",
  "rule_id": null,
  "fields": null,
  "order": null,
  "dir": null,
  "universe_id": null,
  "cadence": "realtime",
  "channel": "webhook",
  "target_url": "https://example.com/hook-v2",
  "delivery": "webhook",
  "status": "active",
  "source": "v2",
  "subscription_origin": { "type": "ticker", "ref": "NVDA", "condition": "gap_up AND high_volume_alert" },
  "last_predicate_value": true,
  "created_at": 1778720416,
  "updated_at": 1785160931,
  "last_match_set": ["NVDA"],
  "last_evaluated_at": 1785160800,
  "next_eval_at": 1785161100,
  "last_fired": 1785160800,
  "last_error": null,
  "last_eval_error_at": null
}