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

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.

POST/overlays/{overlayId}/celebrate
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
overlayIdstringrequired

The overlay's id (o_ + 8 hex chars).

Request body
application/json
widget_idstring

A celebration widget instance id from GET /overlays/{overlayId}. Omit to fire every celebration widget on the overlay.

Responses
200

Broadcast sent.

successboolean
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
404

No such resource.

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
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.tippage.com/v1/overlays/o_1a2b3c4d/celebrate' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "widget_id": "celebration-mt9x2ab"
}'
Response
{
  "success": true
}