Skip to content

Commit 4a2638f

Browse files
docs: add kick reward redemption variables
1 parent 5ccc5e1 commit 4a2638f

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Reward Redemption
3+
description: Trigger for a Kick Channel Reward Redemption
4+
version: 1.0.2
5+
variables:
6+
- name: reward.id
7+
description: The ID of the reward that was redeemed
8+
type: string
9+
value: "01KKYB2KFPMSBMAGYHWQRH2SV0"
10+
- name: reward.title
11+
description: The title of the reward that was redeemed
12+
type: string
13+
value: "My Reward"
14+
- name: reward.description
15+
description: The description of the reward that was redeemed
16+
type: string
17+
value: "This is my cool reward"
18+
- name: reward.cost
19+
description: The cost of the reward that was redeemed
20+
type: int
21+
value: 100
22+
- name: reward.backgroundColor
23+
description: The background color of the reward that was redeemed, in hex format
24+
type: string
25+
value: "#e5e5e5"
26+
- name: reward.skipsQueue
27+
description: Whether the reward that was redeemed skips the queue
28+
type: bool
29+
value: false
30+
- name: reward.requiresUserInput
31+
description: Whether the reward that was redeemed requires user input
32+
type: bool
33+
value: true
34+
- name: rawInput
35+
type: string
36+
description: The raw user input for the reward redemption, if applicable
37+
value: "This is my reward input"
38+
- name: rawInputEscaped
39+
type: string
40+
description: The raw user input for the reward redemption, escaped
41+
value: "This is my reward input"
42+
- name: rawInputUrlEncoded
43+
type: string
44+
description: The raw user input for the reward redemption, URL encoded
45+
value: "This%20is%20my%20reward%20input"
46+
commonVariables:
47+
- KickBroadcaster
48+
- KickUser
49+
---

0 commit comments

Comments
 (0)