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.
chat.commandWebhookapplication/jsonidstringrequiredUnique event id.
typeanyrequiredcreatedstring<date-time>requiredactorobject | nullrequiredWho 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 propertiesHide properties
nulltypestringrequireduserchatapi_keyoauth_appoverlaybotuser_idstring | nullTipPage user id (u_...). Always set for user actors; set for chat actors when the chatter's account is linked to a TipPage user.
platformstring | nulluser / chat actors - the platform account behind the actor
twitchkicknullplatform_idstring | nulluser / chat actors - the account's id on that platform
loginstring | nulluser / chat actors
display_namestring | nulluser / chat actors
idstring | nullapi_key (ak_...) / oauth_app (oc_..., the client id) / overlay (o_..., the overlay id) actors
namestring | nullapi_key / oauth_app / overlay actors
authorization_idstring | nulloauth_app actors only - the authorization (oa_...) the app acts under
dataChatCommandDatarequiredCustom chat command execution payload.
Show propertiesHide properties
platformstringWhich chat the command was typed in.
twitchkickcommandstringCanonical command name
invoked_asstringThe name the viewer actually typed (canonical name or an alias).
argsstring | nullThe rest of the chat line after the command, original case.
user_idstring | nullThe chatter's user id on that platform.
user_loginstring | nulluser_namestring | nullDisplay name.
is_modbooleanChatter is a moderator or the broadcaster.
message_idstring | nullThe chat message id on that platform - dedupe on this.
Return any 2xx quickly.