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

character.held

A viewer’s picture for an AI character is waiting for a moderator on the Review page (the character’s “hold pictures” setting). Approve or reject happens in the dashboard; character.reviewed follows.

POSTcharacter.heldWebhook
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
idstring
characterobject
Show properties
idstring
namestring
reasonstring
Allowed:imagefiltermanual
platformstring
Allowed:twitchkick
user_loginstring | null
user_namestring | null
Responses
200

Acknowledged

Payload
{
  "id": "evt_9f1e2d3c4b5a6978",
  "type": "character.held",
  "created": "2019-08-24T14:15:22Z",
  "actor": {
    "type": "chat",
    "user_id": null,
    "platform": "twitch",
    "platform_id": "123456789",
    "login": "modname",
    "display_name": "ModName"
  },
  "data": {
    "id": "ci_0123456789abcdef",
    "character": {
      "id": "string",
      "name": "string"
    },
    "reason": "image",
    "platform": "twitch",
    "user_login": "string",
    "user_name": "string"
  }
}
Response
Acknowledged