Fire a celebration on one overlay
Fires the Event celebration widget on this overlay only. The widget’s own configuration decides the look (confetti / emotes, style, duration); overlays without the widget ignore the trigger. Pass widget_id (from the overlay’s celebrations list) to fire just ONE of several placed celebration widgets. Requires overlays:manage.
/overlays/{overlayId}/celebrateAuthorizationBearer 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.
overlayIdstringrequiredThe overlay's id (o_ + 8 hex chars).
application/jsonwidget_idstringA celebration widget instance id from GET /overlays/{overlayId}. Omit to fire every celebration widget on the overlay.
Broadcast sent.
successbooleanMissing 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_scopestringNo such resource.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Rate limit exceeded - check the RateLimit-* headers.
errorstring