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

tip.created

A tip entered the TTS queue, from any source - data.source says which (a webhook-testing tip says test, a replay says replay). tts_url is always null here; the audio renders asynchronously and arrives via tip.tts_ready.

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

dataTipCreatedDatarequired
Show properties
order_idstring
namestring
amountnumber | null
messagestring | null
sourcestring

Where the tip came from. manual is the dashboard's manual-tip form; api is a POST /tips tip - check external_source / is_paid to tell a paid-elsewhere tip from a free or manual one.

Allowed:stripepaypalmanualapireplaysub_rewardayupcctestdevunknown
external_sourcestring | null

Developer-API tips only - the source label sent to POST /tips (where the tip came from). null otherwise.

external_refstring | null

Developer-API tips only - the caller's reference.

is_paidboolean

Real money changed hands. true for Stripe, PayPal and developer-API tips sent with paid: true; false for manual tips, sub rewards and free integration tips.

is_replayboolean
is_sub_rewardboolean
platformstring | null

Platform of the signed-in donor

Allowed:twitchkicknull
platform_user_idstring | null

The donor's id on that platform

name_was_filteredboolean
message_was_filteredboolean
tts_urlnull

Always null here - listen for tip.tts_ready (standard voices are rendered when an alert box first plays the tip).

Responses
200

Return any 2xx quickly; do real work asynchronously.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "tip.created",
  "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",
    "name": "string",
    "amount": 0,
    "message": "string",
    "source": "stripe",
    "external_source": "string",
    "external_ref": "string",
    "is_paid": true,
    "is_replay": true,
    "is_sub_reward": true,
    "platform": "twitch",
    "platform_user_id": "string",
    "name_was_filtered": true,
    "message_was_filtered": true,
    "tts_url": null
  }
}
Response
Return any 2xx quickly; do real work asynchronously.