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

queue.tts.removed

A queued TTS was removed before playing (moderation).

POSTqueue.tts.removedWebhook
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
tipEventTip

Tip object carried inside queue.tts.* event payloads. Same fields as the REST queue shape, except the queue timestamp is named created_at.

Show properties
order_idstring
namestring
amountnumber | null
messagestring | null
tts_urlstring<uri> | null
is_replayboolean
is_sub_rewardboolean
sourcestring

Where the tip came from: stripe, paypal, manual (dashboard manual tip), api (POST /tips), sub_reward, replay, test, ayupcc, or unknown for tips older than source tracking.

external_sourcestring | null

Developer-API tips only - the source label the caller sent (kofi, ayupcc); null for every other source. Says where the tip came from, not whether money moved - see is_paid.

external_refstring | null

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

is_paidboolean

Real money changed hands (Stripe, PayPal, or a developer-API tip sent with paid: true). false for manual tips, free integration tips and sub rewards - those never count toward the streamer's totals.

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
created_atstring<date-time>
Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "queue.tts.removed",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "tip": {
      "order_id": "string",
      "name": "string",
      "amount": 0,
      "message": "string",
      "tts_url": "http://example.com",
      "is_replay": true,
      "is_sub_reward": true,
      "source": "string",
      "external_source": "string",
      "external_ref": "string",
      "is_paid": true,
      "platform": "twitch",
      "platform_user_id": "string",
      "name_was_filtered": true,
      "message_was_filtered": true,
      "created_at": "2019-08-24T14:15:22Z"
    }
  }
}
Response
Return any 2xx quickly.