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

tip.filtered

A tip went through, but the word filter (or the AI filter) replaced words in its name or message before it reached the queue. Unusually for this API, the payload includes the pre-filter originals - seeing what was caught is the point of the event. reasoning is the AI filter’s explanation, when the AI filter made the call.

POSTtip.filteredWebhook
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
order_idstring | null
namestring | null

The filtered name (what shows on stream).

original_namestring | null

The name as the donor typed it.

amountnumber | null
currencystring | null
messagestring | null

The filtered message.

original_messagestring | null

The message as the donor typed it.

matched_wordsstring[]
reasoningstring | null
Responses
200

Return any 2xx quickly.

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "tip.filtered",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "order_id": "string",
    "name": "string",
    "original_name": "string",
    "amount": 0,
    "currency": "string",
    "message": "string",
    "original_message": "string",
    "matched_words": [
      "string"
    ],
    "reasoning": "string"
  }
}
Response
Return any 2xx quickly.