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

kick.* (follow, sub, resub, gift_sub, kicks)

Kick alerts - the same shape as the twitch.* events with platform: "kick", forwarded before the filter like them (per-overlay alert settings do not gate it). Types: kick.follow, kick.sub, kick.resub, kick.gift_sub, kick.kicks. Kick subscriptions carry no tier (tier is always "1"). kick.kicks is Kick’s paid gift - the counterpart of a cheer - with kicks (the amount), gift_name and the viewer’s kicks_message.

POSTkick.followWebhook
Request body
application/json
idstringrequired

Unique event id.

typestringrequired
Allowed:kick.followkick.subkick.resubkick.gift_subkick.kicks
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": "kick.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.