Skip to main content
Kick logo
  • Category: social media accounts
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 25
  • Triggers: 0
  • Slug: KICK
  • Version: 20261101_00

Tools

Slug: KICK_BAN_OR_TIMEOUT_USERBan a user from a broadcaster chat, or apply a temporary timeout when duration_minutes is supplied.

Input Parameters

string
Moderator-visible reason for the ban or timeout.
integer
required
User to ban or time out.
integer
Timeout duration in minutes. Omit this field to permanently ban the user.
integer
required
Broadcaster whose chat will enforce the moderation action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_CREATE_CHANNEL_REWARDCreate a channel point reward owned by the connected Kick app.

Input Parameters

integer
required
Channel point cost to redeem the reward.
string
required
Reward title shown to viewers.
boolean
Whether viewers can redeem the reward.
string
Optional reward description shown to viewers.
string
Reward background color as a six-digit hexadecimal value.
boolean
Whether redemption requires viewer text input.
boolean
Whether redemptions are fulfilled without entering the request queue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_CREATE_EVENT_SUBSCRIPTIONSCreate one or more webhook event subscriptions for the authorized broadcaster using the Kick app’s configured callback.

Input Parameters

array
required
Unique Kick event name and version pairs to subscribe to.
string
Delivery method. Kick currently supports webhook delivery only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_DELETE_CHANNEL_REWARDPermanently delete a channel reward created by the connected Kick app.

Input Parameters

string
required
ULID of the app-owned channel reward to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_DELETE_CHAT_MESSAGEPermanently delete a chat message by message ID using the connected moderator identity.

Input Parameters

string
required
ID of the chat message to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_DELETE_EVENT_SUBSCRIPTIONSPermanently delete one or more webhook event subscriptions by ID.

Input Parameters

array
required
Subscription IDs to permanently delete. Each ID is sent as a repeated id query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_ENROLL_IN_ADSIrreversibly enroll the authorized broadcaster channel in Kick’s ads program, changing account-level ad settings. Kick documents no API to unenroll the channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_AD_BREAK_STATUSReturn ad enrollment, blocking conditions, limits, remaining capacity, and recent ad breaks for the authorized channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_CHANNELSReturn the authorized channel when no selector is supplied, or look up channels by broadcaster user IDs or slugs, without exposing stream credentials.

Input Parameters

array
Channel slugs to look up. Sent as repeated slug query keys; each slug is at most 25 characters and the list is mutually exclusive with broadcaster_user_ids.
array
Broadcaster user IDs to look up. Sent as repeated broadcaster_user_id query keys; mutually exclusive with slugs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_KICKS_LEADERBOARDReturn lifetime, monthly, and weekly KICKs leaderboards for the authorized broadcaster.

Input Parameters

integer
Maximum ranked users to return in each leaderboard period (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_LIVESTREAM_STATSReturn the current aggregate count of active livestreams on Kick.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_USER_LIVESTREAMSReturn active Kick livestreams for 1 to 100 specific user IDs.

Input Parameters

array
required
User IDs whose active livestreams to return. Each ID is sent as a repeated user_id query key; provide between 1 and 100 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_USERSReturn the authorized Kick user when no IDs are supplied, or look up users by ID.

Input Parameters

array
User IDs to look up. Each ID is sent as a repeated id query key. Omit this field to return the authorized user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_GET_WEBHOOK_PUBLIC_KEYReturn Kick’s PEM public key for verifying signatures on received webhook events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_LIST_CATEGORIESFind Kick categories by names, tags, or IDs and return one cursor-paginated page.

Input Parameters

array
Category tags to match; values are sent as one comma-separated tag query parameter.
integer
Maximum categories to return in this page (1-1000).
array
Category names to match; values are sent as one comma-separated name query parameter.
string
Opaque next cursor from a previous response; omit for the first page.
array
Category IDs to retrieve; values are sent as one comma-separated id query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_LIST_CHANNEL_REWARDSReturn all channel point rewards on the authorized broadcaster’s channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_LIST_EVENT_SUBSCRIPTIONSList webhook event subscriptions owned by the connected Kick app, optionally for one broadcaster.

Input Parameters

integer
Only return subscriptions for this broadcaster’s numeric Kick user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_LIST_LIVESTREAMSDiscover active Kick livestreams by category or language and return one cursor-paginated page.

Input Parameters

integer
Maximum livestreams to return in this page (1-1000).
string
Opaque next cursor from a previous response; omit for the first page.
array
Category IDs to include; each value is sent as a repeated category_id query key (maximum 25).
array
BCP 47 language codes to include; each value is sent as a repeated language_code query key (maximum 25).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_LIST_REWARD_REDEMPTIONSReturn one page of channel reward redemptions filtered by reward and status, or by redemption IDs. Status defaults to pending unless redemption IDs are supplied.

Input Parameters

string
Opaque next cursor from a previous response; omit for the first page.
string ("pending" | "accepted" | "rejected")
Redemption status to return; defaults to pending and cannot be used with redemption_ids.
string
Reward ULID whose redemptions to return; cannot be used with redemption_ids.
array
Specific redemption ULIDs. Each value is sent as a repeated id query key; cannot be combined with reward_id or status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_REMOVE_MODERATION_BANRemove a user’s ban or active timeout from a broadcaster chat.

Input Parameters

integer
required
User whose ban or timeout should be removed.
integer
required
Broadcaster whose chat contains the ban or timeout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_RESOLVE_REWARD_REDEMPTIONSAccept or reject up to 25 pending channel reward redemptions in one explicit decision.

Input Parameters

string ("accept" | "reject")
required
Final status to apply to all supplied pending redemptions.
array
required
One to 25 unique pending redemption ULIDs to accept or reject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_SEND_CHAT_MESSAGEImmediately send a Kick chat message as the authorized user or connected bot, optionally as a reply.

Input Parameters

string
required
Chat message text to send immediately, limited to 500 grapheme clusters and 2048 UTF-8 bytes.
string ("user" | "bot")
required
Send as the authorized user or the connected bot.
integer
Destination broadcaster ID. Required when sender_type is user and forbidden when sender_type is bot.
string
Message UUID to reply to, if this message is a reply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_START_AD_BREAKImmediately start an ad break on the authorized live Kick broadcaster channel when its ad capabilities permit it.

Input Parameters

string
required
Caller-generated UUID used by Kick as the idempotency and request ID. Reuse the same UUID only when retrying the same intended ad break; use a new UUID for a new ad break.
integer
required
Length of the ad break in seconds, from 7 through 90.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_UPDATE_CHANNELUpdate one or more metadata fields on the authorized broadcaster’s livestream channel.

Input Parameters

integer
Category ID to assign to the authorized broadcaster’s channel.
array
Complete custom-tag list to set on the channel. Pass an empty list to clear all custom tags.
string
New livestream title for the authorized broadcaster’s channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KICK_UPDATE_CHANNEL_REWARDUpdate one or more fields on a channel reward created by the connected Kick app.

Input Parameters

integer
Replacement channel point cost to redeem the reward.
string
Replacement reward title shown to viewers.
boolean
Whether reward redemptions are temporarily paused.
string
required
ULID of the app-owned channel reward to update.
boolean
Whether viewers can redeem the reward.
string
Replacement reward description shown to viewers.
string
Replacement reward background color as a six-digit hex value.
boolean
Whether redemption requires viewer text input.
boolean
Whether redemptions bypass the request queue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not