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

Skip the alert on screen

Cut the alert the overlay is showing (a gift bomb reading every recipient, a long raid). Pass event_id to pin the request to THAT alert, so one landing after it ended can’t skip the next. The event is marked skipped and never replayed on a reconnect. Requires tts:control.

POST/alerts/skip
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.

Request body
application/json
event_idstring

The alert to skip (ev_..., from /alerts/now). Omit to skip whatever is on screen.

Responses
200

Skipped.

successboolean
skipped_event_idstring | null
401

Missing 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).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

required_scopestring
409

not_displaying - no alert is on screen, or the one named has already finished. skip_disabled - skipping is locked on this channel.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.tippage.com/v1/alerts/skip' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "event_id": "string"
}'
Response
{
  "success": true,
  "skipped_event_id": "string"
}