---
search:
  tags:
    - Webhook events
    - POST
    - Webhook
seo:
  description: >-
    Twitch alerts, forwarded the moment they arrive - before the streamer's
    filter… Reference for the POST twitch.follow webhook in the TipPage
    Developer API.
sidebar:
  label: twitch.* (follow, sub, resub, gift_sub, cheer, raid)
  badge: POST
title: twitch.* (follow, sub, resub, gift_sub, cheer, raid)
type: openapi-operation
---
Twitch alerts, forwarded the moment they arrive - before the streamer's filter runs and whatever it decides; the filter only gates the overlays and the bot, so check the text yourself before showing it (a repeat follow inside the follow cooldown is dropped). Which alerts an overlay shows is configured per overlay and does not gate the webhook - every event fires. Types: `twitch.follow`, `twitch.sub`, `twitch.resub`, `twitch.gift_sub`, `twitch.cheer`, `twitch.raid`. Fields beyond the user identity are present only where they make sense (tier on subs, bits on cheers, viewers on raids, ...). One Twitch sub can be TWO events, and both fire: `twitch.sub` at payment (a non-sub became a sub - a first sub, a lapsed return, a Prime re-up) and `twitch.resub` when the viewer shares (months + message; seconds or hours later, sometimes first). `paired_event_id` on either names the other half's `event_id` once it exists (null on whichever lands first); `continuing: true` on a `twitch.sub` means the viewer has subscribed to this channel before (a re-up or a return, Prime or paid), whose share, if they press it, carries their months. `twitch.sub` fires at payment, as Twitch sent it; the alert box plays a Sub only once Twitch's own chat announces it (a first-time sub, within seconds; never a returning one, whose share is the alert). Show one or the other, the way the alert box does.

`POST twitch.follow`

**Webhook.** The API sends this request to your endpoint.

**Payload** (`application/json`)

- `id` (string, required) — Unique event id.
- `type` (string, required)
- `created` (string<date-time>, required)
- `actor` (object | null, required) — Who caused the event. \`null\` for system-originated events (a payment landing, an overlay heartbeat lapsing). Otherwise one of \`user\` (a team member in the dashboard), \`chat\` (a moderator's chat command via the bot), \`api\_key\` (a developer API key), \`oauth\_app\` (an OAuth-connected app), \`overlay\` (the overlay reporting start/finish) or \`bot\`.
- `data` (TwitchEventData, required) — Platform alert payload (\`twitch.\*\` and \`kick.\*\` events). \`platform\`, \`user\_name\` and \`user\_login\` are always present; the rest depend on the event type.

Payload example:

```json
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "twitch.follow",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "event_id": "string",
    "platform": "twitch",
    "user_name": "string",
    "user_login": "string",
    "profile_image_url": "string",
    "message": "string",
    "tier": "string",
    "months": 0,
    "sub_message": "string",
    "paired_event_id": "string",
    "continuing": true,
    "total": 0,
    "is_anonymous": true,
    "gift_recipients": [
      "string"
    ],
    "bits": 0,
    "viewers": 0,
    "kicks": 0,
    "gift_name": "string",
    "kicks_message": "string"
  }
}
```

**Responses**

- `200` — Return any 2xx quickly.
