Integration

TipeeeStream

Receive donation alerts from TipeeeStream directly in FaustBot. Popular in European streaming communities for tip processing.

Overview

TipeeeStream is a donation platform popular with European creators. FaustBot connects via their API:

Donation Alerts

Real-time tip notifications.

Multi-Currency

Support for EUR, USD, and more.

Supporter Info

Access donor name and message.

Custom Actions

Trigger any action on tips.

Setup

Get API Key

Configure FaustBot

In FaustBot, go to Integrations → TipeeeStream. Paste your API key and click Connect.

Test Connection

Send a test donation through TipeeeStream and verify it triggers in FaustBot.

Triggers

Donation Received A supporter sent a tip

Trigger Variables

Variable	Description
`%userName%`	Donor's display name
`%amount%`	Donation amount
`%currency%`	Currency code
`%formattedAmount%`	Amount with currency symbol
`%message%`	Message from donor

Effects

No specific effects are available for TipeeeStream. Use the donation triggers to activate alerts, sounds, TTS, or OBS changes.

Scripting API

Control and query TipeeeStream donations from your scripts using the CPH API:

Connection Management

Connection management

# Check if connected to TipeeeStream
connected = CPH.TipeeeStreamIsConnected()

# Check if authenticated
authenticated = CPH.TipeeeStreamIsAuthenticated()

# Get connection info
info = CPH.TipeeeStreamGetConnectionInfo()

# Connect / Disconnect
CPH.TipeeeStreamConnect()
CPH.TipeeeStreamDisconnect()

Donation Data

Donation data

# Get recent donations
donations = CPH.TipeeeStreamGetDonations(10)

# Get donations with filters
filtered = CPH.TipeeeStreamGetDonationsFiltered({
    "limit": 20,
    "sort": "amount",
    "order": "desc",
    "minAmount": 5.0
})

# Get specific donation by ID
donation = CPH.TipeeeStreamGetDonation("donation_id")

# Get last donation/tip
last = CPH.TipeeeStreamGetLastDonation()
tip = CPH.TipeeeStreamGetLastTip()

# Get real-time events from Socket.IO
events = CPH.TipeeeStreamGetRecentEvents()
count = CPH.TipeeeStreamGetRecentEventCount()

Statistics and Utilities

Statistics and utilities

# Get donation statistics
stats = CPH.TipeeeStreamGetStatistics()
# Contains: totalAmount, totalDonations, averageAmount, currency,
#           topDonorName, topDonorAmount, todayAmount, weekAmount, monthAmount

# Get top donors
top_donors = CPH.TipeeeStreamGetTopDonors(5)
for donor in top_donors:
    CPH.SendMessage(f"{donor['name']}: {donor['amount']}")

# Get totals (shorthand)
totals = CPH.TipeeeStreamGetTotals()

# Get user info
user = CPH.TipeeeStreamGetUserInfo()

# Format amount with currency
formatted = CPH.TipeeeStreamFormatAmount(10.50, "EUR")  # "10.50 EUR"

# Convert to cents
cents = CPH.TipeeeStreamToCents(5.99)  # 599

Available Methods

Method	Description
`TipeeeStreamIsConnected()`	Check if connected to TipeeeStream
`TipeeeStreamIsAuthenticated()`	Check if OAuth/API key is valid
`TipeeeStreamGetConnectionInfo()`	Get connection details map
`TipeeeStreamConnect()`	Connect to TipeeeStream
`TipeeeStreamDisconnect()`	Disconnect from TipeeeStream
`TipeeeStreamGetUserInfo()`	Get current user info
`TipeeeStreamGetDonations(limit)`	Get recent donations
`TipeeeStreamGetDonationsFiltered(options)`	Get donations with filters
`TipeeeStreamGetDonation(id)`	Get specific donation by ID
`TipeeeStreamGetRecentEvents()`	Get real-time Socket.IO events
`TipeeeStreamGetStatistics()`	Get donation statistics
`TipeeeStreamGetTopDonors(limit)`	Get top donors list
`TipeeeStreamGetTotals()`	Get total amounts shorthand
`TipeeeStreamGetLastDonation()`	Get last donation event
`TipeeeStreamGetLastTip()`	Get last tip event
`TipeeeStreamGetLastSubscription()`	Get last subscription event
`TipeeeStreamGetLastCheer()`	Get last cheer event
`TipeeeStreamGetLastFollow()`	Get last follow event
`TipeeeStreamFormatAmount(amount, currency)`	Format amount with currency symbol
`TipeeeStreamToCents(amount)`	Convert amount to cents

See the full API reference for more details.