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

twitch.channel_point_redemption

A viewer redeemed a channel point reward. Fires for EVERY reward on the channel - including rewards TipPage has no actions mapped to - so you can build your own redemption automations. The redeemer’s name and text input are sent as Twitch sent them, before the streamer’s word/AI filter runs and whatever it decides - check the text yourself before showing it. Delivery is at-least-once: dedupe on data.redemption_id (stable across Twitch redeliveries, unlike the envelope id). When is_managed is true, close the loop with the fulfill/cancel endpoints once your automation has run.

POSTtwitch.channel_point_redemptionWebhook
Request body
application/json
idstringrequired

Unique event id.

typeanyrequired
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

dataChannelPointRedemptionDatarequired

Channel point redemption payload.

Show properties
user_namestring | null

Redeemer display name (as on Twitch

user_loginstring | null
profile_image_urlstring | null

The redeemer's Twitch profile picture.

reward_idstring

Twitch reward id.

reward_titlestring | null
reward_costinteger | null

Cost in channel points.

user_inputstring | null

The viewer's text input (as typed, unfiltered), when the reward asks for one.

redemption_idstring

Twitch redemption id - dedupe on this.

statusstring

Redemption status at event time (normally unfulfilled).

redeemed_atstring<date-time> | null
is_managedboolean

The reward was created by TipPage - which is what makes the redemption resolvable via the fulfill/cancel endpoints (Twitch restricts resolution to the creating app).

Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "twitch.channel_point_redemption",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "user_name": "string",
    "user_login": "string",
    "profile_image_url": "string",
    "reward_id": "string",
    "reward_title": "string",
    "reward_cost": 0,
    "user_input": "string",
    "redemption_id": "string",
    "status": "string",
    "redeemed_at": "2019-08-24T14:15:22Z",
    "is_managed": true
  }
}
Response
Return any 2xx quickly.