# TipPage Docs > Guides for setting up your TipPage donation page, overlay, alerts, and chat bot. ## Docs - [Welcome](https://docs.tippage.com/): Everything you need to set up TipPage - tips, alerts, overlays, and your chat bot. - [TipPage+](https://docs.tippage.com/tippage-plus): The optional upgrade - custom domain, AI word filter, custom bot account, chargeback cover, and AI voices for £9.99 a month. - [Privacy](https://docs.tippage.com/privacy): What you can see of your tippers, what they can see of you, and how TipPage keeps both directions safe. ## Getting started - [Getting started](https://docs.tippage.com/getting-started): A tipping platform for streamers - tips, alerts, overlays, and a chat bot, for at most 1% + 3p per card tip and nothing else. - [Create your account](https://docs.tippage.com/getting-started/create-your-account): Sign up with Twitch or Kick, pick your TipPage link, and you're in. No invite needed. - [Dashboard tour](https://docs.tippage.com/getting-started/dashboard-tour): A quick map of my.tippage.com - what every page in the sidebar does. ## Payments - [Link Stripe](https://docs.tippage.com/payments/link-stripe): Connect Stripe to take card, Apple Pay, and Google Pay tips - with payouts straight to your bank. - [Link PayPal](https://docs.tippage.com/payments/link-paypal): Take tips through PayPal - just enter the email of the account that should receive the money. - [Getting paid](https://docs.tippage.com/payments/getting-paid): Where the money goes, what it costs, and how refunds and chargebacks work. - [Tip reports](https://docs.tippage.com/payments/reports): Generate a PDF statement of your tips for any period - paid tips by processor, tips paid elsewhere, free sub-reward tips, and manual tips kept separate. ## Tip page - [Customise your page](https://docs.tippage.com/tip-page/customize-your-page): Your colours, your logo, your words - everything on the Branding tab. - [Use a custom domain](https://docs.tippage.com/tip-page/custom-domain): Point your own domain at your tip page - one DNS record and a Link click. - [What viewers see](https://docs.tippage.com/tip-page/what-viewers-see): The tip flow from your viewer's side - amounts, messages, media requests, TTS preview, and receipts. ## Overlay - [Create an overlay](https://docs.tippage.com/overlay/create-an-overlay): Make an overlay, grab its browser source URL, and keep the key secret. - [Add your overlay to OBS](https://docs.tippage.com/overlay/add-to-obs): One browser source, four settings, done - including the audio step everyone misses. - [Edit your overlay](https://docs.tippage.com/overlay/edit-your-overlay): The overlay editor - drag, resize, and style your widgets on your overlay's canvas. - [Overlay widgets](https://docs.tippage.com/overlay/widgets): Every widget explained - tip alerts, media, tip goal, chat, leaderboards, celebrations, and more. - [Custom widgets](https://docs.tippage.com/overlay/custom-widgets): Build your own overlay widgets with HTML, CSS, and JS - StreamElements custom widgets run as-is. ## Alerts - [Tip alerts](https://docs.tippage.com/alerts/tip-alerts): What plays on stream when someone tips - and where each part of it is configured. - [Twitch alerts](https://docs.tippage.com/alerts/twitch-alerts): Follows, subs, gift subs, resubs, bits, raids, and channel point redemptions - configured per overlay, announced in chat by the bot. - [Test your alerts](https://docs.tippage.com/alerts/test-alerts): Fire free test alerts at your overlay - no payment, no waiting for a real tip. ## Queues and playback - [Controls](https://docs.tippage.com/queues/controls): Your live-ops page - pause, skip, open or close the queue, and linked queue mode. - [TTS](https://docs.tippage.com/queues/tts): The voice that reads tips on stream - queue, history, voice settings, and AI voices. - [Media requests](https://docs.tippage.com/queues/media-requests): Viewer-requested YouTube videos - limits, volumes, the backup playlist, and what gets auto-skipped. ## Chat bot - [TipPageBot in your chat](https://docs.tippage.com/chat-bot/tippage-bot): Enable the bot, mod it, and choose which commands it answers. - [Alert announcements](https://docs.tippage.com/chat-bot/announcements): The bot's chat messages for follows, subs, gift subs, resubs, cheers, raids, and tips - each with an editable template. - [Custom commands](https://docs.tippage.com/chat-bot/custom-commands): Your own chat commands - with variables, random picks, response lists, permissions, and cooldowns. - [Timers](https://docs.tippage.com/chat-bot/timers): Messages the bot posts on its own schedule - fixed or random intervals, gated on chat activity or being live. - [Modules](https://docs.tippage.com/chat-bot/modules): Built-in chat games and tools - live announcements, emote pyramids and combos, a viewer queue, votekick and giveaways - each with its own switch and messages. - [Use your own bot account](https://docs.tippage.com/chat-bot/custom-bot): Send bot messages from your own Twitch account instead of TipPageBot - a TipPage+ feature. ### Variables - [Variables](https://docs.tippage.com/chat-bot/variables): Everything that can go inside {curly braces} in a command response, timer message or announcement - and how to combine them. - [{user}](https://docs.tippage.com/chat-bot/variables/user): The person who ran the command - and everything TipPage knows about them. - [{touser}](https://docs.tippage.com/chat-bot/variables/touser): Who the command is aimed at - the first word the viewer typed, or the viewer themselves. - [{channel}](https://docs.tippage.com/chat-bot/variables/channel): Your channel name. - [{platform}](https://docs.tippage.com/chat-bot/variables/platform): Which platform the message is running on - twitch or kick. - [{args}](https://docs.tippage.com/chat-bot/variables/args): Everything the viewer typed after the command, word for word. - [{arg:N}](https://docs.tippage.com/chat-bot/variables/arg): The Nth word the viewer typed after the command. - [{msgid}](https://docs.tippage.com/chat-bot/variables/msgid): The id of the chat message that triggered the command. - [{pick:a|b|c}](https://docs.tippage.com/chat-bot/variables/pick): One of the options, chosen at random. - [{list:name}](https://docs.tippage.com/chat-bot/variables/list): A random line from one of your response lists. - [{random:1-100}](https://docs.tippage.com/chat-bot/variables/random): A random whole number in the range. - [{if:…}](https://docs.tippage.com/chat-bot/variables/if): Say one thing or another depending on a comparison. - [{repeat:N|text}](https://docs.tippage.com/chat-bot/variables/repeat): The text repeated N times, separated by spaces. - [{upper:…} / {lower:…}](https://docs.tippage.com/chat-bot/variables/upper-lower): The text in ALL CAPS or all lowercase. - [{queryescape:…} / {pathescape:…}](https://docs.tippage.com/chat-bot/variables/queryescape-pathescape): Make text safe to put in a URL - as a query value, or as part of the path. - [{uptime}](https://docs.tippage.com/chat-bot/variables/uptime): How long the stream has been live. - [{title}](https://docs.tippage.com/chat-bot/variables/title): The stream title. - [{game}](https://docs.tippage.com/chat-bot/variables/game): The category the channel is streaming. - [{viewers}](https://docs.tippage.com/chat-bot/variables/viewers): The current viewer count. - [{emote} / {emotes}](https://docs.tippage.com/chat-bot/variables/emotes): One of your channel emotes at random, or all of them. - [{7tv} / {bttv} / {ffz}](https://docs.tippage.com/chat-bot/variables/third-party-emotes): A random 7TV, BetterTTV or FrankerFaceZ emote from your channel - or from any set you point it at. - [{followage}](https://docs.tippage.com/chat-bot/variables/followage): How long someone has been following the channel. - [{accountage}](https://docs.tippage.com/chat-bot/variables/accountage): How old someone's Twitch account is. - [{tips.…}](https://docs.tippage.com/chat-bot/variables/tips): Your channel's tip totals - today, this month, all time, the latest tip, your top supporter - and your tip page's minimum and maximum. - [{tip_page}](https://docs.tippage.com/chat-bot/variables/tip-page): Your tip page address, ready to paste into chat. - [{tts.queue} / {media.queue} / {media.now}](https://docs.tippage.com/chat-bot/variables/queue): What's waiting in your TTS and media queues, and what's playing. - [{count} / {counter:name}](https://docs.tippage.com/chat-bot/variables/count): Counters that tick up every time a command runs. - [{urlfetch:https://…}](https://docs.tippage.com/chat-bot/variables/urlfetch): Replace the variable with whatever text a URL returns. - [{ai:prompt}](https://docs.tippage.com/chat-bot/variables/ai): A one-line reply from an AI model, written to your prompt. ## Viewers and rewards - [Sub rewards](https://docs.tippage.com/viewers/sub-rewards): Give your subscribers free message credits - a thank-you their sub already earned. - [Channel points](https://docs.tippage.com/viewers/channel-points): Turn a Twitch channel point redemption into a TipPage action - credits, alerts, bot messages, or song requests. ## Team - [Invite team members](https://docs.tippage.com/team/invite-team-members): Give mods and editors dashboard access with a single-use invite link - or quick-add your Twitch or Kick mods. - [Permissions](https://docs.tippage.com/team/permissions): What each team member permission actually grants - and when to use Super Admin. ## Moderation - [Word filter](https://docs.tippage.com/moderation/word-filter): Block words outright or swap them for something safer - before they ever reach your stream. - [AI filter](https://docs.tippage.com/moderation/ai-filter): A bypass-aware filter that catches what a wordlist can't - built to stop doxxing on stream. - [Review queue](https://docs.tippage.com/moderation/review-queue): Put a moderator between "paid" and "played" - read the message, look at the media, decide what goes on stream. - [Bans, refunds, and notifications](https://docs.tippage.com/moderation/bans-and-refunds): Block repeat offenders, process refund requests, and get it all pinged to your Discord. ## Api - [Overview](https://docs.tippage.com/api): TipPage's developer API - API keys, the REST endpoints, signed webhooks, and a live event stream. - [Authentication](https://docs.tippage.com/api/authentication): Create an API key, send it as a bearer token, and pick the scopes it carries. - [OAuth 2.0](https://docs.tippage.com/api/oauth): Let other streamers connect your app to their TipPage with a Connect button - authorization code + PKCE, refresh tokens, and the same scopes as API keys. - [Webhooks](https://docs.tippage.com/api/webhooks): Signed event envelopes POSTed to your server - the catalog, how to verify them, and the operational warnings. - [Realtime WebSocket](https://docs.tippage.com/api/realtime): Stream every TipPage event live over a plain WebSocket - no SDK, any language. Connect with your API key, or hand short-lived tokens to clients that shouldn't see it. - [Claim, do your thing, finish](https://docs.tippage.com/api/claim-and-finish): How start/finish works, why it's built that way, and how to write a consumer that behaves well. - [Guides](https://docs.tippage.com/api/guides): Putting the API to work - the chat bot loop, viewer sub-reward credits, AI voices, and a worked end-to-end example. - [Accounts, teams and platforms](https://docs.tippage.com/api/accounts-teams-platforms): How TipPage is put together - tenants, users and their sign-in accounts, connected channels - and what "both Twitch and Kick" means feature by feature and in the API. ### Reference - [TipPage Developer API](https://docs.tippage.com/api/reference) #### Identity - [Event and scope catalog](https://docs.tippage.com/api/reference/identity/listeventtypes) - [Who am I](https://docs.tippage.com/api/reference/identity/getme) #### Realtime - [Mint a realtime handoff token](https://docs.tippage.com/api/reference/realtime/mintrealtimetoken) #### TTS queue - [Claim a TTS as now playing](https://docs.tippage.com/api/reference/tts-queue/startttsitem) - [Clear the whole TTS queue](https://docs.tippage.com/api/reference/tts-queue/cleartts) - [Finish a TTS](https://docs.tippage.com/api/reference/tts-queue/finishttsitem) - [Pause the TTS queue](https://docs.tippage.com/api/reference/tts-queue/pausetts) - [Pending TTS queue](https://docs.tippage.com/api/reference/tts-queue/getttsqueue) - [Played TTS history](https://docs.tippage.com/api/reference/tts-queue/getttshistory) - [Release a claimed TTS back to the queue](https://docs.tippage.com/api/reference/tts-queue/releasettsitem) - [Remove one queued TTS](https://docs.tippage.com/api/reference/tts-queue/removettsitem) - [Replay a TTS from history](https://docs.tippage.com/api/reference/tts-queue/replayttsitem) - [Resume the TTS queue](https://docs.tippage.com/api/reference/tts-queue/resumetts) - [Skip the currently-playing TTS](https://docs.tippage.com/api/reference/tts-queue/skiptts) - [What's playing right now](https://docs.tippage.com/api/reference/tts-queue/getttsnow) #### Media queue - [Claim a media item as now playing](https://docs.tippage.com/api/reference/media-queue/startmediaitem) - [Finish a media item](https://docs.tippage.com/api/reference/media-queue/finishmediaitem) - [Hide the media player](https://docs.tippage.com/api/reference/media-queue/hidemediaplayer) - [Pause the media queue](https://docs.tippage.com/api/reference/media-queue/pausemedia) - [Pending media queue](https://docs.tippage.com/api/reference/media-queue/getmediaqueue) - [Played media history](https://docs.tippage.com/api/reference/media-queue/getmediahistory) - [Queue a video](https://docs.tippage.com/api/reference/media-queue/createmediaitem) - [Release a claimed media item back to the queue](https://docs.tippage.com/api/reference/media-queue/releasemediaitem) - [Remove one queued media item](https://docs.tippage.com/api/reference/media-queue/removemediaitem) - [Replay a media item from history](https://docs.tippage.com/api/reference/media-queue/replaymediaitem) - [Resume the media queue](https://docs.tippage.com/api/reference/media-queue/resumemedia) - [Show the media player](https://docs.tippage.com/api/reference/media-queue/showmediaplayer) - [Skip the currently-playing media](https://docs.tippage.com/api/reference/media-queue/skipmedia) - [What's playing right now](https://docs.tippage.com/api/reference/media-queue/getmedianow) #### Tipping - [Close tipping](https://docs.tippage.com/api/reference/tipping/closetipping) - [Create a tip](https://docs.tippage.com/api/reference/tipping/createmanualtip) - [Is tipping open](https://docs.tippage.com/api/reference/tipping/gettippingstatus) - [Open tipping](https://docs.tippage.com/api/reference/tipping/opentipping) - [Top supporters](https://docs.tippage.com/api/reference/tipping/getleaderboard) #### Viewers - [A viewer's sub-reward history](https://docs.tippage.com/api/reference/viewers/listviewerrewards) - [Grant credits](https://docs.tippage.com/api/reference/viewers/grantviewercredits) - [List signed-in viewers](https://docs.tippage.com/api/reference/viewers/listviewers) - [One viewer in full](https://docs.tippage.com/api/reference/viewers/getviewer) - [Revoke credits](https://docs.tippage.com/api/reference/viewers/revokeviewercredits) #### Channel points - [Cancel a redemption (refund the points)](https://docs.tippage.com/api/reference/channel-points/cancelredemption) - [Mark a redemption fulfilled](https://docs.tippage.com/api/reference/channel-points/fulfillredemption) #### Chat bot - [Bot status](https://docs.tippage.com/api/reference/chat-bot/getbotstatus) - [Create a command](https://docs.tippage.com/api/reference/chat-bot/createcustomcommand) - [Delete a command](https://docs.tippage.com/api/reference/chat-bot/deletecustomcommand) - [Get one command](https://docs.tippage.com/api/reference/chat-bot/getcustomcommand) - [List custom commands](https://docs.tippage.com/api/reference/chat-bot/listcustomcommands) - [Send a chat message](https://docs.tippage.com/api/reference/chat-bot/sendchatmessage) - [Update a command](https://docs.tippage.com/api/reference/chat-bot/updatecustomcommand) #### Chat timers - [Create a timer](https://docs.tippage.com/api/reference/chat-timers/createchattimer) - [Delete a timer](https://docs.tippage.com/api/reference/chat-timers/deletechattimer) - [Get one timer](https://docs.tippage.com/api/reference/chat-timers/getchattimer) - [List timers](https://docs.tippage.com/api/reference/chat-timers/listchattimers) - [Update a timer](https://docs.tippage.com/api/reference/chat-timers/updatechattimer) #### Counters - [Delete a counter](https://docs.tippage.com/api/reference/counters/deletecounter) - [Increment a counter](https://docs.tippage.com/api/reference/counters/incrementcounter) - [List counters](https://docs.tippage.com/api/reference/counters/listcounters) - [Read a counter](https://docs.tippage.com/api/reference/counters/getcounter) - [Set a counter](https://docs.tippage.com/api/reference/counters/setcounter) #### Overlays - [Add to an overlay's tip goal](https://docs.tippage.com/api/reference/overlays/addtooverlaytipgoal) - [Delete an overlay](https://docs.tippage.com/api/reference/overlays/deleteoverlay) - [Fire a celebration everywhere](https://docs.tippage.com/api/reference/overlays/celebratealloverlays) - [Fire a celebration on one overlay](https://docs.tippage.com/api/reference/overlays/celebrateoverlay) - [Get an overlay's tip goal](https://docs.tippage.com/api/reference/overlays/getoverlaytipgoal) - [Get one overlay](https://docs.tippage.com/api/reference/overlays/getoverlay) - [List overlays](https://docs.tippage.com/api/reference/overlays/listoverlays) - [Reload an overlay](https://docs.tippage.com/api/reference/overlays/reloadoverlay) - [Update an overlay's tip goal](https://docs.tippage.com/api/reference/overlays/updateoverlaytipgoal) #### AI voices - [Disable AI voices](https://docs.tippage.com/api/reference/ai-voices/disableaivoices) - [Disable one voice](https://docs.tippage.com/api/reference/ai-voices/disableaivoice) - [Enable AI voices](https://docs.tippage.com/api/reference/ai-voices/enableaivoices) - [Enable one voice](https://docs.tippage.com/api/reference/ai-voices/enableaivoice) - [List AI voices](https://docs.tippage.com/api/reference/ai-voices/listaivoices) #### Webhook endpoints - [Add an endpoint](https://docs.tippage.com/api/reference/webhook-endpoints/createwebhookendpoint) - [Delete an endpoint](https://docs.tippage.com/api/reference/webhook-endpoints/deletewebhookendpoint) - [Get one endpoint](https://docs.tippage.com/api/reference/webhook-endpoints/getwebhookendpoint) - [List endpoints](https://docs.tippage.com/api/reference/webhook-endpoints/listwebhookendpoints) - [Recent deliveries](https://docs.tippage.com/api/reference/webhook-endpoints/listwebhookdeliveries) - [Redeliver a delivery](https://docs.tippage.com/api/reference/webhook-endpoints/redeliverwebhookdelivery) - [Rotate the signing secret](https://docs.tippage.com/api/reference/webhook-endpoints/rotatewebhooksecret) - [Send a test event](https://docs.tippage.com/api/reference/webhook-endpoints/pingwebhookendpoint) - [Update an endpoint](https://docs.tippage.com/api/reference/webhook-endpoints/updatewebhookendpoint)