Alert history
Platform alerts, newest first. By default the finished ones: every alert the overlay played or that was skipped. With status=all, every platform event as it happened - those still waiting for an overlay (waiting), those the live alert box never showed because the type is off or under its minimum (not_played), and every channel-point redemption, whether or not a box alerted on it (a redemption that never alerted is a channel_points row whose id is Twitch’s redemption id, status not_played, nothing to replay). A tip-filter-blocked alert is never listed. limit up to 200. Requires tts:read.
/alerts/historyAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
limitintegerstatusstringall = every platform event, not only the finished ones.
finishedallbeforestring<date-time>Cursor - a happened_at from a previous page (next_cursor). Returns rows strictly older than it.
One page of alerts.
alertsAlert[]Show propertiesHide properties
Alertidstringev_... - the event id the webhooks carry.
typestringfollowsubscriptiongift_subscriptioncheerraidkickschannel_pointsevent_typestring | nullThe payload type (channel.subscription.message tells a resub from a sub).
platformstringtwitchkicknamestringWho it was from.
profile_image_urlstring | nulltierstring | nullTwitch tier id (1000, 2000, 3000); 1 on Kick.
totalinteger | nullGift subs - how many.
bitsinteger | nullviewersinteger | nullRaids.
kicksinteger | nullmonthsinteger | nullResubs.
messagestring | nullThe viewer's own text
reward_titlestring | nullChannel point redemptions.
reward_costinteger | nullChannel point redemptions - the reward's cost in points.
redemption_idstring | nullChannel point redemptions - Twitch's id of the redemption.
gift_recipientsstring[]Gifted subs - who received them, as Twitch's gift notices named them. Empty when none were caught (a gift whose notices never arrived, an older row).
statusstringwaiting, not_played and paired only appear with status=all. paired = a Twitch sub's half the overlay swallowed because its other half was the alert; the two are listed as one row, so it is only seen on its own when the pair fell outside the page. A Twitch sub payment Twitch's chat has not announced is waiting for a few seconds and not_played after that - no overlay was offered it; its share, if the viewer presses it, is the alert and turns it paired.
playedskippedpairedwaitingnot_playedis_replaybooleanreplay_ofstring | nullThe original's id when this was a replay.
paired_event_idstring | nullA Twitch sub's two events (the payment, the share) are listed as ONE row carrying the share's months and message at the payment's time; this is the other half's id. id is the half the overlay played (what a replay plays), the share when both or neither did.
happened_atstring<date-time>finished_atstring<date-time> | nullWhen it left the screen.
has_morebooleannext_cursorstring | nullPass as ?before= to fetch the next page.
Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring