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

tip.reviewed

A moderator decided a held tip, or its Stripe payment hold expired before anyone did. decision is approved, rejected or expired; allow_tts / allow_media say which halves were let through. An approval is followed by the normal tip.created and/or media.created as the tip enters the queues. payment_released is true when a held authorisation was cancelled - the donor was never charged. payment_kept is true when a blocked tip was rejected but its held payment captured anyway.

POSTtip.reviewedWebhook
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

dataobjectrequired
Show properties
order_idstring
decisionstring
Allowed:approvedrejectedexpired
allow_ttsboolean
allow_mediaboolean
reasonstring
Allowed:manualfilterai_unavailablemedia_lookalike
payment_statestring
Allowed:capturedheldnone
payment_releasedboolean
payment_keptboolean
namestring | null
amountnumber | null
currencystring | null
Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "tip.reviewed",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "order_id": "string",
    "decision": "approved",
    "allow_tts": true,
    "allow_media": true,
    "reason": "manual",
    "payment_state": "captured",
    "payment_released": true,
    "payment_kept": true,
    "name": "string",
    "amount": 0,
    "currency": "string"
  }
}
Response
Return any 2xx quickly.