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

twitch.* (follow, sub, resub, gift_sub, cheer, raid)

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.

POSTtwitch.followWebhook
Request body
application/json
idstringrequired

Unique event id.

typestringrequired
Allowed:twitch.followtwitch.subtwitch.resubtwitch.gift_subtwitch.cheertwitch.raid
createdstring<date-time>required
actorobject | nullrequired

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.

Show properties
One of:
null
null
object
typestringrequired
Allowed:userchatapi_keyoauth_appoverlaybot
user_idstring | null

TipPage user id (u_...). Always set for user actors; set for chat actors when the chatter's account is linked to a TipPage user.

platformstring | null

user / chat actors - the platform account behind the actor

Allowed:twitchkicknull
platform_idstring | null

user / chat actors - the account's id on that platform

loginstring | null

user / chat actors

display_namestring | null

user / chat actors

idstring | null

api_key (ak_...) / oauth_app (oc_..., the client id) / overlay (o_..., the overlay id) actors

namestring | null

api_key / oauth_app / overlay actors

authorization_idstring | null

oauth_app actors only - the authorization (oa_...) the app acts under

dataTwitchEventDatarequired

Platform alert payload (twitch.* and kick.* events). platform, user_name and user_login are always present; the rest depend on the event type.

Show properties
event_idstring

The alert's permanent id (ev_ + 16 hex) - the same id the activity feed uses.

platformstring

Which platform the viewer is on.

Allowed:twitchkick
user_namestring | null

Display name.

user_loginstring | null
profile_image_urlstring | null

The viewer's profile picture on their platform (Twitch via Helix, Kick's own) - the one the alert box shows. Null for an anonymous gifter or when the lookup failed.

messagestring | null

Human-readable alert line ("X subscribed at Tier 2!").

tierstring

Sub tier: 1 / 2 / 3 (subs, resubs, gifts).

monthsinteger

Cumulative months (resubs).

sub_messagestring

The viewer's resub message.

paired_event_idstring | null

Subs and resubs: the event_id of the other half of the same payment (a sub's share, a share's payment) once it exists; null on whichever of the two landed first.

continuingboolean

Subs only: the viewer has subscribed to this channel before (a re-up or a return, Prime or paid), not a first-time sub; their share, if they press it, carries the months. Twitch's own chat announces only a first-time sub at payment.

totalinteger

Gift count (gift subs).

is_anonymousboolean

Anonymous gifter (gift subs).

gift_recipientsstring[]

Recipient names attributed to a gift bomb.

bitsinteger

Bits cheered (cheers).

viewersinteger

Raid party size (raids).

kicksinteger

Kicks gifted (kick.kicks).

gift_namestring | null

The Kicks gift's name (kick.kicks).

kicks_messagestring | null

The viewer's note on a Kicks gift (kick.kicks).

Responses
200

Return any 2xx quickly.

Payload
{
  "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"
  }
}
Response
Return any 2xx quickly.