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

chat.command

A viewer executed one of the streamer’s custom chat commands - the hook for turning commands into real-world triggers (!explode firing actual hardware). Emits only after the command’s permission and cooldown checks pass, and only for custom commands - built-ins like !queue never fire it. command is the canonical command name; invoked_as is what the viewer typed (differs when an alias was used). Delivery is at-least-once: dedupe on data.message_id.

POSTchat.commandWebhook
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

dataChatCommandDatarequired

Custom chat command execution payload.

Show properties
platformstring

Which chat the command was typed in.

Allowed:twitchkick
commandstring

Canonical command name

invoked_asstring

The name the viewer actually typed (canonical name or an alias).

argsstring | null

The rest of the chat line after the command, original case.

user_idstring | null

The chatter's user id on that platform.

user_loginstring | null
user_namestring | null

Display name.

is_modboolean

Chatter is a moderator or the broadcaster.

message_idstring | null

The chat message id on that platform - dedupe on this.

Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "chat.command",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "platform": "twitch",
    "command": "string",
    "invoked_as": "string",
    "args": "string",
    "user_id": "string",
    "user_login": "string",
    "user_name": "string",
    "is_mod": true,
    "message_id": "string"
  }
}
Response
Return any 2xx quickly.