You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/chatbot/variables/customapi.md
+23-7Lines changed: 23 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,25 @@
1
1
---
2
2
id: customapi
3
3
sidebar_label: "$(customapi)"
4
-
description: "Learn how to use the $(customapi) variable in StreamElements Chatbot to make API requests and display responses in chat."
4
+
description: "Learn how to use $(customapi) in StreamElements Chatbot to make API requests and display responses in chat messages."
5
+
tags:
6
+
- variables
7
+
- api
8
+
- integrations
5
9
keywords:
6
10
- StreamElements
7
11
- chatbot
8
12
- customapi
9
13
- API request
10
14
- variable
15
+
- urlfetch
11
16
---
12
17
13
-
# $(customapi)
18
+
# $(customapi) Variable
14
19
15
20
## Overview
16
21
17
-
The `$(customapi)` variable allows you to make a request to a specified URL and return the response directly in chat. This powerful feature enables you to integrate external data sources into your stream's chat messages.
22
+
The `$(customapi)` variable enables you to make HTTP requests to external APIs and display the responses directly in your stream's chat. This powerful feature allows you to integrate real-time data from various sources into your chat messages and commands.
18
23
19
24
## Usage
20
25
@@ -24,11 +29,11 @@ To use the `$(customapi)` variable, include it in your chat message or command r
24
29
$(customapi URL)
25
30
```
26
31
27
-
Replace `URL` with the actual API endpoint you want to call.
32
+
Replace *URL* with the actual API endpoint you want to call.
The `$(customapi)` variable itself does not take any parameters. However, you can include query parameters in the URL you're requesting if the API requires them.
60
+
The `$(customapi)` variable itself doesn't accept parameters. However, you can include query parameters in the URL if the API requires them. For example:
description: "Learn how to use the $(ffzemotes) variable to display active FrankerFaceZ emotes in your Twitch channel."
3
5
tags:
4
6
- chatbot
5
7
- variable
8
+
- emotes
6
9
keywords:
7
10
- ffz
8
11
- emotes
9
12
- frankerfacez
13
+
- twitch
14
+
- chat
10
15
---
11
16
12
-
# $(ffzemotes)
17
+
# $(ffzemotes) Variable
18
+
19
+
## Overview
20
+
21
+
The `$(ffzemotes)` variable is used to display a list of active FrankerFaceZ (FFZ) emotes in your Twitch channel. This can be helpful for viewers to see which custom emotes are available for use in the chat.
22
+
23
+
## Usage
13
24
14
-
Lists the active FrankerFaceZ emotes in the channel.
25
+
To use this variable, simply include `$(ffzemotes)`in your chat message or command response. The chatbot will automatically replace it with a list of active FFZ emotes.
15
26
16
-
#### Parameters
27
+
##Examples
17
28
18
-
This variable does not take any parameters.
29
+
### Example 1: Displaying FFZ Emotes
30
+
31
+
**Command:**
32
+
```
33
+
!ffzemotes
34
+
```
35
+
36
+
**Chatbot Response:**
37
+
```
38
+
The active FFZ emotes in this channel are: $(ffzemotes)
39
+
```
40
+
41
+
**Output:**
42
+
```
43
+
The active FFZ emotes in this channel are: LULW KEKW 5Head PogU
-[$(bttvemotes)](bttvemotes): Lists active BetterTTV emotes in the channel
70
+
-[$(7tvemotes)](7tvemotes): Lists active 7TV emotes in the channel
71
+
72
+
## FAQ
73
+
74
+
**Q: How often is the FFZ emote list updated?**
75
+
76
+
A: The FFZ emote list is cached for 48 hours. To update the list immediately, you can use the command `!emotes reload`.
77
+
78
+
**Q: Can I filter or limit the number of emotes displayed?**
79
+
80
+
A: The `$(ffzemotes)` variable doesn't have built-in filtering or limiting options. To manipulate the output, you'll need to use additional StreamElements variables or custom code.
81
+
82
+
**Q: What if there are no FFZ emotes in the channel?**
83
+
84
+
A: If there are no active FFZ emotes, the variable will return an empty string.
0 commit comments