Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Replay an alert from the history

Play an alert again through the connected overlay’s alert box, exactly like the original: a new event (event_id) with replay_of set, marked as a replay on screen. No webhook, no sub-reward credit, no chat announce, no filter run. With no overlay connected the replay is parked (parked: true) and plays on the next connect. Requires tts:control.

POST/alerts/{id}/replay
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired
A 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.
Path parameters
idstringrequired
The alert's `id` from the history (`ev_...`).
Responses
200Replaying (or parked).
successboolean
event_idstring
The replay's own event id.
replay_ofstring
parkedboolean
No overlay is connected - it plays on the next connect.
overlayobject | null
The overlay whose alert box will show it.
401Missing or invalid credential (`missing_api_key` / `invalid_api_key`, or `invalid_token` for an expired/revoked OAuth access token).
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
403The key lacks the required scope (`missing_scope`).
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
required_scopestring
404No such alert in the history.
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
409`overlay_wont_show` - the connected overlay's alert box would not show it (`reason` = type_off | platform_off | under_minimum | reward_not_listed, `overlay` names it). `blocked` - the original was blocked by the tip filter.
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
429Rate limit exceeded - check the `RateLimit-*` headers.
errorstring
Request
curl -X POST "https://api.tippage.com/v1/alerts/string/replay" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "success": true,
  "event_id": "string",
  "replay_of": "string",
  "parked": true,
  "overlay": {}
}