List webhooks
https://api.tickerbot.io/ v2/ webhooksLists every webhook on your account, newest first.
Query parameters
string[]enumFilter 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.
active | The subscription is live and being evaluated. |
disabled | Turned 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 50Page size. Max 100.
stringThe 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.
Returns
as_ofstringServer time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).
countnumberThe webhooks in this page.
next_cursorstringOpaque token for the next page; null on the last page. Pass it back as cursor.
webhooksarrayYour subscriptions, newest first, each with its subscription_origin and health fields. signing_secret is stripped: it is shown only on create.
Status codes
| Code | Meaning |
|---|---|
200 | Success: the response shape is documented under Returns above. |
400 | A status value other than active or disabled, an invalid limit, or a malformed cursor. |
Notes
- Account-wide, not per key: every API key on your account sees the same list.
- Each result carries a
subscription_origindiscriminator naming which subscribe endpoint created it:scan,signal,ticker,eventornews. - Every result carries
last_errorandlast_eval_error_at, the answer to "why is my webhook not firing?".last_erroris null on a healthy hook; when an evaluation fails it holds the reason, andlast_eval_error_atwhen it last happened. Delivery failures show onfailing_sinceand on List deliveries. - Results carry the same full key set as
GET /v2/webhooks/{webhook}:select,universe,orderanddir(the sort in effect),channel,last_errorandconsecutive_failures; an event webhook addskindandticker, a news webhooksearch,tickerandmin_relevance. The example above is abridged.