Platform

Kick Integration

Full Kick integration with chat, subscriptions, gifted subs, and real-time events.

Overview

FaustBot provides comprehensive Kick support with real-time WebSocket connections:

Live Chat

Real-time chat messages with full user data and badges.

Subscriptions

New subs, resubs, and gifted subscriptions.

Follows

New follower notifications.

Raids

Incoming raids with viewer counts.

Connecting Your Account

1

Open Kick Settings

Click Kick in the sidebar to open the Kick integration page.

2

Enter Channel Name

Enter your Kick channel username. This is the name in your channel URL (e.g., kick.com/yourchannel).

3

Connect

Click Connect to start receiving events from your channel. FaustBot will connect to Kick's WebSocket for real-time updates.

Screenshot: Kick connection

Bot Account

To send messages as a bot, you'll need to authenticate with a Kick account. Click Login with Kick to authenticate for chat sending.

Available Triggers

Chat Events

Chat Message Any message in chat with user info and badges
First Message User's first message in your channel

Subscription Events

Subscription New subscription
Resub Resubscription with months
Gift Sub Gifted subscription
Gift Subs Multiple gifted subs at once

Channel Events

Follow New follower
Raid Incoming raid with viewer count
Stream Online Stream went live
Stream Offline Stream ended

Effects

Send Message

Send a message to Kick chat.

Delete Message

Remove a message from chat.

Timeout User

Timeout a user for specified duration.

Ban User

Permanently ban a user.

Unban User

Remove a ban from a user.

Clear Chat

Clear all messages in chat.

Variables

VariableDescription
%user%Kick username
%displayName%Display name
%userId%Kick user ID
%message%Chat message text
%isSubscriber%Whether user is subscribed
%isModerator%Whether user is a moderator
%isVip%Whether user is a VIP
%isOg%Whether user has OG badge
%months%Subscription months
%giftCount%Number of gifted subs
%viewers%Raid viewer count

Scripting API

Access Kick features from your scripts:

Handling Subscriptions

Handle Kick subscriptions 
# Handle Kick subscriptions
def Execute():
    user = args["displayName"]
    months = int(args["months"])
    is_gift = args.get("isGifted", False)

    # Log the subscription
    CPH.LogInfo(f"{user} subscribed for {months} months")

    # Different reactions based on months
    if months >= 12:
        CPH.RunAction("Annual Sub Alert")
        CPH.ObsSetScene("Celebration")
    elif months >= 6:
        CPH.RunAction("Loyal Sub Alert")

    # Announce to chat
    if is_gift:
        CPH.SendMessage(f"Welcome {user} with a gifted sub!")
    else:
        CPH.SendMessage(f"Thanks {user} for {months} months!")

    return True

Chat Moderation

Moderate Kick chat messages 
# Moderate Kick chat messages
def Execute():
    user = args["displayName"]
    message = args["message"].lower()
    is_mod = args.get("isModerator", False)

    # Skip moderators
    if is_mod:
        return True

    # Define banned words
    banned_words = ["spam", "badword", "promo"]

    for word in banned_words:
        if word in message:
            CPH.LogInfo(f"Filtered message from {user}")
            CPH.KickTimeoutUser(user, 60)
            CPH.KickDeleteMessage(args["messageId"])
            CPH.SendMessage(f"@{user} that word is not allowed here.")
            return False

    return True

Stream Information

Display stream information 
# Display stream information
def Execute():
    # Get current stream info
    channel = CPH.KickGetChannelInfo()

    if channel:
        title = channel["title"]
        category = channel["category"]
        viewers = channel["viewerCount"]
        is_live = channel["isLive"]

        if is_live:
            CPH.SendMessage(f"Currently streaming: {title}")
            CPH.SendMessage(f"Category: {category} | Viewers: {viewers}")
        else:
            CPH.SendMessage("Stream is currently offline")

    return True

Raid Handling

Handle incoming Kick raids 
# Handle incoming Kick raids
def Execute():
    raider = args["displayName"]
    viewers = int(args["viewers"])

    CPH.LogInfo(f"Raid from {raider} with {viewers} viewers")

    # Scale reaction based on raid size
    if viewers >= 100:
        CPH.RunAction("Massive Raid Alert")
        CPH.ObsSetScene("Raid Celebration")
    elif viewers >= 25:
        CPH.RunAction("Big Raid Alert")
    else:
        CPH.RunAction("Raid Alert")

    # Welcome message
    CPH.SendMessage(f"Welcome raiders from {raider}! Thanks for bringing {viewers} friends!")

    # Shoutout the raider
    CPH.SendMessage(f"Go check out {raider} at kick.com/{raider}!")

    return True

See the full API reference for all available methods.