Fire a celebration everywhere

Fires the Event celebration widget on every connected overlay that carries one - confetti and/or channel emotes, using each widget’s own configured look. Overlays without the widget ignore it. Requires overlays:manage.

POST/overlays/celebrate

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

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

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

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X POST "https://api.tippage.com/v1/overlays/celebrate" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/overlays/celebrate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://api.tippage.com/v1/overlays/celebrate",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true
}