---
search:
  tags:
    - Overlays
    - POST
seo:
  description: >-
    Fires the Event celebration widget on this overlay only. The… Reference for
    the POST /overlays/{overlayId}/celebrate endpoint in the TipPage Developer
    API.
sidebar:
  label: Fire a celebration on one overlay
  badge: POST
title: Fire a celebration on one overlay
type: openapi-operation
---
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`

**Request body** (`application/json`)

- `widget_id` (string) — A celebration widget instance id from GET /overlays/{overlayId}. Omit to fire every celebration widget on the overlay.

Request body example:

```json
{
  "widget_id": "celebration-mt9x2ab"
}
```

**Responses**

- `200` — Broadcast sent.
- `401` — Missing or invalid credential (\`missing\_api\_key\` / \`invalid\_api\_key\`, or \`invalid\_token\` for an expired/revoked OAuth access token).
- `403` — The key lacks the required scope (\`missing\_scope\`).
- `404` — No such resource.
- `429` — Rate limit exceeded - check the \`RateLimit-\*\` headers.

Response example, 200:

```json
{
  "success": true
}
```
