List deliveries
https://api.tickerbot.io/ v2/ webhooks/ {webhook}/ deliveriesLists a webhook's recent deliveries: what was sent and what came back.
Path parameters
stringrequiredWebhook id.
Query parameters
string[]enumFilter by delivery status (one or a comma list).
pending | Queued or mid-retry; not yet accepted by your target. |
delivered | Your target answered 2xx. |
permanent_failure | Gave up: the retry schedule ran out, or the destination refused it for good (a Discord target answered 4xx, or the mobile device is gone). A test fire is never retried. |
stringOnly deliveries created at or after this moment: YYYY-MM-DD or a UTC timestamp (YYYY-MM-DDTHH:MM:SSZ); a date-only value starts at the beginning of that UTC day. Delivery history is retained for 90 days; deleting a webhook deletes its delivery history with it.
stringWindow end (deliveries created up to this moment): same value grammar as from. A date-only value covers that whole UTC day. A timestamp is included until 2027-01-12 and exclusive from then, as everywhere else (Deprecations). from after to is a 400. See Time windows.
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 deliveries in this page.
next_cursorstringOpaque token for the next page; null on the last page. Pass it back as cursor.
deliveriesarrayDeliveries, newest first. Every row carries every field below; times are epoch seconds.
idstringThe delivery id (dlv_…). Your endpoint receives it in X-Tickerbot-Delivery-Id (a resend sends the original's).
webhook_idstringThe webhook it belongs to.
eventstringenumWhat fired.
webhook.fired | A ticker, signal or scan webhook: tickers started matching. |
events.fired | An event webhook: events landed. |
news.fired | A news webhook: articles landed. |
statusstringenumWhere the delivery stands.
pending | Queued or mid-retry; not yet accepted by your target. |
delivered | Your target answered 2xx. |
permanent_failure | Gave up: the retry schedule ran out, or the destination refused it for good (a Discord target answered 4xx, or the mobile device is gone). A test fire is never retried. |
attemptnumberAttempts made so far.
last_status_codenumberThe HTTP status your endpoint returned on the last attempt; null when it could not be reached, before the first attempt, and on in-app deliveries.
last_errorstringWhy the last attempt failed when your endpoint could not be reached (a network error or the 10-second timeout); null when it answered (see last_status_code) or on success. Discord and mobile-push deliveries also describe a rejected request here.
channelstringenumWhere it went.
webhook | POST the payload to an HTTPS endpoint you own, signed with X-Tickerbot-Signature. |
discord | Post to a Discord channel via its webhook URL. Delivered as a Discord embed, never HMAC-signed: the URL is itself the credential. |
in_app | Deliver to the in-app feed. No external receiver, so nothing to validate and no test_url. |
mobile_push | Push to a registered device. Requires a device_id from Register a device. |
target_urlstringThe HTTPS endpoint it was sent to; null on every channel except webhook.
body_stringstringThe exact JSON body, as sent.
created_atnumberWhen it was queued (epoch seconds).
delivered_atnumberWhen your endpoint accepted it (epoch seconds); null until then.
next_attempt_atnumberWhen the next attempt is due, while pending (epoch seconds); null on a failed test fire, which is never retried.
expires_atnumberWhen it leaves the 90-day delivery history (epoch seconds); null on rows older than the field.
redelivery_ofstringOn a resend: the original delivery's id; null otherwise.
testbooleantrue on a test fire.
Status codes
| Code | Meaning |
|---|---|
200 | Success: the response shape is documented under Returns above. |
400 | Invalid webhook id format, invalid ?status value, a malformed from/to (or from after to), an invalid limit, or a malformed cursor. |
404 | Webhook not found, or owned by another account. |
Notes
- Account-scoped: any key on the same account can read any webhook's deliveries.
- Retries: 30s, 2m, 10m, 1h, 3h, 6h, 12h (8 POSTs, about 22 hours), then the delivery is
permanent_failure. When a delivery fails for good after deliveries have kept failing for 72 hours (sincefailing_since) with none getting through, the webhook is disabled; we email you the first time a delivery fails for good. - Resend any delivered or failed delivery (not a test fire; the webhook must be on) with
POST /v2/webhooks/{webhook}/deliveries/{delivery}/redeliver.