tickerbot.io

List webhooks

GEThttps://api.tickerbot.io/v2/webhooks

Lists every webhook on your account, newest first.

string[]enum

Filter by status: active, disabled or both as a comma list. A webhook is always one of the two (disabled covers a user pause, the automatic disable after deliveries have kept failing for 72 hours with none getting through, and the automatic disable of a trigger that cannot run; disabled_reason on each record says which: user_disabled, delivery_failure, evaluation_failure, plan_downgrade or subscription_canceled). Omit for all.

activeThe subscription is live and being evaluated.
disabledTurned off; disabled_reason says why. user_disabled: you turned it off. delivery_failure: deliveries kept failing for 72 hours with none getting through. evaluation_failure: its rule can no longer run, such as when a signal it reads was removed or its universe was deleted. plan_downgrade: the account moved to a plan with fewer webhooks, and the newest beyond the new limit were turned off. subscription_canceled: the paid subscription ended. Turn it back on with PATCH /v2/webhooks/{webhook} and enabled: true.
integerdefault 50

Page size. Max 100.

string

The previous response's next_cursor. Send it with the same params as the first page (limit may change); a page whose params differ is a 400 naming the param.

as_ofstring

Server time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).

countnumber

The webhooks in this page.

next_cursorstring

Opaque token for the next page; null on the last page. Pass it back as cursor.

webhooksarray

Your subscriptions, newest first, each with its subscription_origin and health fields. signing_secret is stripped: it is shown only on create.

CodeMeaning
200Success: the response shape is documented under Returns above.
400A status value other than active or disabled, an invalid limit, or a malformed cursor.
  • Account-wide, not per key: every API key on your account sees the same list.
  • Each result carries a subscription_origin discriminator naming which subscribe endpoint created it: scan, signal, ticker, event or news.
  • Every result carries last_error and last_eval_error_at, the answer to "why is my webhook not firing?". last_error is null on a healthy hook; when an evaluation fails it holds the reason, and last_eval_error_at when it last happened. Delivery failures show on failing_since and on List deliveries.
  • Results carry the same full key set as GET /v2/webhooks/{webhook}: select, universe, order and dir (the sort in effect), channel, last_error and consecutive_failures; an event webhook adds kind and ticker, a news webhook search, ticker and min_relevance. The example above is abridged.