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

queue.media.started / finished / removed

A media item started (queue.media.started) or finished (queue.media.finished) playing, or was removed from the queue before playing (queue.media.removed).

POSTqueue.media.startedWebhook
Request body
application/json
idstringrequired

Unique event id.

typestringrequired
Allowed:queue.media.startedqueue.media.finishedqueue.media.removed
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
mediaEventMedia

Media object carried inside queue.media.* event payloads (queue timestamp named created_at).

Show properties
order_idstring
donor_namestring
media_urlstring<uri>
media_start_timeinteger
video_titlestring | null
video_thumbnailstring<uri> | null
video_durationinteger
platformstring
requested_viastring
is_replayboolean
created_atstring<date-time>
Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "queue.media.started",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "media": {
      "order_id": "string",
      "donor_name": "string",
      "media_url": "http://example.com",
      "media_start_time": 0,
      "video_title": "string",
      "video_thumbnail": "http://example.com",
      "video_duration": 0,
      "platform": "string",
      "requested_via": "string",
      "is_replay": true,
      "created_at": "2019-08-24T14:15:22Z"
    }
  }
}
Response
Return any 2xx quickly.