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

chat.moderated

Chat moderation acted on a message. One event per enforcement step of the response that ran (a delete, or a timeout or ban), or one warn event when the response only posted messages. feature names where the match came from (rule, bannedWords, links, caps, emotes, symbols, or votekick for a timeout the votekick bot module carried out), rule the streamer’s named rule when one fired, matched_term the phrase that matched. enforced: false means the platform-side action failed - on Twitch the bot isn’t modded in the channel or lacks the moderator scopes, on Kick the streamer’s Kick connection lacks the moderation scopes - and the attempt is still reported so nothing slips by silently. Message text is public chat content. platform says which chat it happened in; Kick moderation is enforced through the streamer’s own Kick connection.

POSTchat.moderatedWebhook
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
platformstring
Allowed:twitchkick
actionstring
Allowed:warndeletetimeoutban
enforcedboolean
duration_secondsinteger | null

Timeout length; null for other actions.

target_user_idstring | null
target_loginstring | null
target_namestring | null
featurestring | null

Where the match came from - rule, bannedWords, links, caps, emotes, symbols, or votekick (a timeout carried out by the votekick bot module).

Allowed:rulebannedWordslinkscapsemotessymbolsvotekicknull
ruleobject | null

The named rule that fired; null for the phrase list and the protections.

Show properties
idstring

mr_ id

namestring | null
matched_termstring | null
messagestring | null
reasonstring | null
Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "chat.moderated",
  "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",
    "action": "warn",
    "enforced": true,
    "duration_seconds": 0,
    "target_user_id": "string",
    "target_login": "string",
    "target_name": "string",
    "feature": "rule",
    "rule": {
      "id": "string",
      "name": "string"
    },
    "matched_term": "string",
    "message": "string",
    "reason": "string"
  }
}
Response
Return any 2xx quickly.