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_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

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

200Broadcast sent.

successboolean

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

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 resource.

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/overlays/o_1a2b3c4d/celebrate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "widget_id": "celebration-mt9x2ab"
}'

const response = await fetch("https://api.tippage.com/v1/overlays/o_1a2b3c4d/celebrate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "widget_id": "celebration-mt9x2ab"
})
});

import requests

response = requests.post(
    "https://api.tippage.com/v1/overlays/o_1a2b3c4d/celebrate",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "widget_id": "celebration-mt9x2ab"
},
)

Response

{
  "success": true
}