Custom Widgets

https://github.com/streamelements/widgets
Admin
A repository for community-created custom widgets for StreamElements.com, enabling users to create,...
Tokens:13,969
Snippets:117
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Full OBS shortcut target example

Source: https://github.com/streamelements/widgets/blob/master/NanoleafLightingOnEvents/README.md

Example of the full path and parameters for the OBS shortcut, which may vary based on your installation directory.

```text
"C:\Program Files (x86)\obs-studio\bin\64bit\obs64.exe" --allow-running-insecure-content --disable-web-security
```

--------------------------------

### Usage of Custom Fields in HTML

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Example of using templating variables within HTML markup.

```HTML
<div class="message">{{someDropdown}} is an option for today!<span id="additional">{{someText}}</span></div>
```

--------------------------------

### Input Field Construction

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Examples of how input fields and dropdowns are rendered on the left panel based on the JSON configuration.

```HTML
<input type="TYPE_FROM_JSON" name="FIELD_NAME" value="USER_VALUE_OR_DEFAULT_VALUE"/>
```

```HTML
<select name="someDropdown">
    <option value="blue" selected>Blue thing</option>
    <option value="apple">Some apple</option>
    <option value="7">Lucky number</option>
</select>
```

--------------------------------

### Import jQueryUI via HTML

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Example of importing an external JavaScript library within the HTML section.

```HTML
<script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.js"></script>
```

--------------------------------

### Event Queue Management with JavaScript

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Example implementation of handling subscriber events and managing the event queue using SE_API.resumeQueue().

```javascript
let skippable=["bot:counter","event","event:test","event:skip","alertService:toggleSound","message","delete-message","delete-messages","kvstore:update"]; //Array of events coming to widget that are not queued so they can come even queue is on hold
let playAnimation=(event)=>{
    $("container").html(`<div id="sender">${event.sender}</div><div class="amount">${event.amount} subs!</div>`)
    return Math.floor(Math.random()*8)+7;
};
window.addEventListener('onEventReceived', function (obj) {
    const listener = obj.detail.listener;
  	console.log(obj.detail);
    const data = obj.detail.event;
	console.log(`RECEIVED ${listener}`);
  	if (skippable.indexOf(listener)!==-1) return;
  	if (listener !== 'subscriber-latest') {
    	console.log("Resuming as event is not sub");
          SE_API.resumeQueue(); 
          return;
        }
  	if (data.bulkGifted !== true && !data.gifted) {
    	  console.log("Resuming as event is not sub gift");
          SE_API.resumeQueue();
          return;
    }    
     if (data.name === data.sender) {
         console.log("Getting animation duration for premature resume");
         let time=playAnimation(data);
         setTimeout(SE_API.resumeQueue,time*1000); 
     }
});
```

--------------------------------

### Import Google Font via HTML

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Example of importing a Google font using a link tag in the HTML section.

```HTML
<link href="https://fonts.googleapis.com/css?family=Chelsea+Market" rel="stylesheet">
```

--------------------------------

### Usage of Custom Fields in CSS

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Example of using templating variables within CSS styles.

```CSS
.message {
    font-size:{{someSlider}}px;
    color: {{someColorPicker}};
}
```

--------------------------------

### Usage of Custom Fields in JavaScript

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Example of accessing field data within the onWidgetLoad event listener.

```javascript
let someVariable,magicNumber;
window.addEventListener('onWidgetLoad', function (obj) {
    const {fieldData} = obj.detail;
    someVariable = fieldData["someText"];
    // OR
    magicNumber = fieldData.someNumber;
    // OR use internal templating variables
    magicNumber = parseFloat("{{someNumber}}");
});
```

--------------------------------

### Handle event data and update DOM

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

An expanded example showing how to extract listener and event details from the event object and update the DOM using jQuery or vanilla JavaScript.

```javascript
window.addEventListener('onEventReceived', function (obj) {
    const listener = obj.detail.listener;
    const data = obj["detail"]["event"];
    // Assigned new const value, for easier handling. You can do it with .property or ["property"]. 
    // I personally recommend using [""] as some of keys can have "-" within, so you won't be able
    // to call them (JS will try to do math operation on it).
    // jQuery is included by default, so you can use following
    $("#usernameContainer").html(data["name"]);
    $("#actionContainer").html(listener);
    //You can use vanilla JS as well
    document.getElementById("amount").innerHTML=data["amount"]
});
```

--------------------------------

### SE_API Global Object Methods

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Examples of using the global SE_API object for data storage, message sanitization, cheer filtering, and retrieving overlay status.

```javascript
SE_API.store.set('keyName', obj); // stores an object into our database under this keyName (multiple widgets using the same keyName will share the same data. keyName can be an alphanumeric string only).
SE_API.store.get('keyName').then(obj => {
    // obj is the object stored in the db, must be a simple object
});
SE_API.counters.get('counterName').then(counter => {
    // counter is of the format { counter, value }
});

SE_API.sanitize({ message: "Hello SomeVulgarWorld"}).then(sanityResult => {
/*
    sanityResult={
        "result":{
            "message":"Hello Kreygasm" //Message after validation
        },
        "skip":false // Should it be skipped according to rules 
    }
*/  
});

SE_API.cheerFilter(message).then(cheerResult => {
	// cheerResult = "message but without any cheers in it";
});

SE_API.setField('key', 'value'); // Sets the fieldData[key] = value. This does not save, so should be used with Editor Mode so the user can save.
SE_API.getOverlayStatus(); // { isEditorMode: true/false, muted: true/false }
```

--------------------------------

### Listen for events with onEventReceived

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

The basic setup for capturing events in a widget using the 'onEventReceived' event listener.

```javascript
window.addEventListener('onEventReceived', function (obj) {
    // fancy stuff here
});
```

--------------------------------

### Import Google Font via CSS

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

Example of importing a Google font using the @import rule within the CSS field.

```CSS
@import url('https://fonts.googleapis.com/css?family=Chelsea+Market');
```

--------------------------------

### Configure OBS shortcut parameters

Source: https://github.com/streamelements/widgets/blob/master/NanoleafLightingOnEvents/README.md

Add these flags to the OBS shortcut target to allow the widget to connect to the Nanoleaf device.

```text
--allow-running-insecure-content --disable-web-security
```

--------------------------------

### SE_API.store.get

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Retrieves an object from the database by its keyName.

```APIDOC
## SE_API.store.get(keyName)

### Description
Retrieves an object from the database. Returns a promise that resolves with the stored object.

### Parameters
- **keyName** (string) - Required - The key identifier for the data.
```

--------------------------------

### SE_API.store.set

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Stores an object into the database under a specific keyName. Widgets sharing the same keyName will share the same data.

```APIDOC
## SE_API.store.set(keyName, obj)

### Description
Stores an object into the database under a specific keyName. KeyName must be an alphanumeric string.

### Parameters
- **keyName** (string) - Required - The key identifier for the data.
- **obj** (object) - Required - The data object to store.
```

--------------------------------

### Listen for onWidgetLoad event

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

The basic event listener for the 'onWidgetLoad' event triggered when a widget is initialized.

```javascript
window.addEventListener('onWidgetLoad', function (obj) {
    //fancy stuff here
});
```

--------------------------------

### onWidgetLoad Event

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

The 'onWidgetLoad' event is triggered when the widget is initialized. It provides a comprehensive object containing session data, recent events, currency, channel details, and field configurations.

```APIDOC
## Event: onWidgetLoad

### Description
Triggered when the widget is loaded. The event object contains detailed information about the current session, channel, and widget configuration.

### Usage
```javascript
window.addEventListener('onWidgetLoad', function (obj) {
    let data = obj["detail"]["session"]["data"];
    let recents = obj["detail"]["recents"];
    let currency = obj["detail"]["currency"];
    let channelName = obj["detail"]["channel"]["username"];
    let apiToken = obj["detail"]["channel"]["apiToken"];
    let fieldData = obj["detail"]["fieldData"];
});
```

### Data Structure
The `data` object contains various keys categorized by event type (Common, Twitch) providing access to goals, latest events, and session statistics.
```

--------------------------------

### Audio element implementation

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomCodeInAlertbox.md

HTML structure for embedding an audio alert.

```html
<audio id="audio" playsinline autoplay ><source id="alertsound" src="{{audio}}" type="audio/ogg"></audio>
```

--------------------------------

### SE_API.resumeQueue

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Resumes the widget event queue.

```APIDOC
## SE_API.resumeQueue()

### Description
Manually triggers the resumption of the widget event queue, useful for handling asynchronous animations.
```

--------------------------------

### Video element implementation

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomCodeInAlertbox.md

HTML structure for embedding a video alert.

```html
<video id="video" playsinline autoplay muted style="width:100%; height:100%"><source id="webm" src="{{video}}" type="video/webm"></video>
```

--------------------------------

### SE_API.getOverlayStatus

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Retrieves the current status of the overlay.

```APIDOC
## SE_API.getOverlayStatus()

### Description
Returns an object containing the current overlay status, including isEditorMode and muted state.
```

--------------------------------

### Widget Duration Configuration

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

JSON configuration for setting the widgetDuration property, which defines the maximum event queue hold time in seconds.

```json
{
    "widgetDuration":{
      "type": "hidden",
      "value": 15
    }
}
```

--------------------------------

### onEventReceived

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

The primary event listener for handling widget-specific events such as bot counters and button clicks.

```APIDOC
## Event: onEventReceived

### Description
Triggered when an event is received by the widget. This is the main entry point for handling bot counters and custom button interactions.

### Event Data
- **listener** (string) - The type of event listener (e.g., 'bot:counter', 'widget-button').
- **event** (object) - The event payload containing specific data based on the listener type.

### Example: Bot Counter
```javascript
window.addEventListener('onEventReceived', function (obj) {
    const listener = obj.detail.listener;
    const data = obj.detail.event;

    if (listener === 'bot:counter' && data.counter === counter) {
        document.getElementById("mycounter").innerHTML=data.value;
    }
});
```
```

--------------------------------

### Alertbox message structure

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomCodeInAlertbox.md

Basic HTML structure for displaying alert messages.

```html
<div class="alertbox-message">
    <div class="alertbox-message-text">
        <span class="alertbox-message-name">{{name}}</span>
        <span class="alertbox-message-announcement">{{announcement}}</span>
    </div>
    <div class="alertbox-message-message">{{message}}</div>
```

--------------------------------

### Handle widget button click events

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Listens for 'widget-button' events and dispatches an emulated message event when specific field and value conditions are met.

```javascript
window.addEventListener('onEventReceived', function (obj) {
    const data = obj.detail.event;
        if (data.listener === 'widget-button') {
            if (data.field==='chat' && data.value==='First Message'){
                const emulated = new CustomEvent("onEventReceived", {
                        detail: {
                            "listener": "message",
                            event: {
                                data: {
                                    text: "Example message!",
                                    displayName: "StreamElements"
                                }
                            }
                        }
                    
                });
                window.dispatchEvent(emulated);
            }
        }
});
```

--------------------------------

### SE_API.counters.get

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Retrieves counter information by name.

```APIDOC
## SE_API.counters.get(counterName)

### Description
Retrieves counter data. Returns a promise that resolves with an object in the format { counter, value }.

### Parameters
- **counterName** (string) - Required - The name of the counter to retrieve.
```

--------------------------------

### Access Host Recent Properties

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Access the amount of viewers for host events.

```javascript
["amount"]; // amount of viewers
```

--------------------------------

### Define Custom Fields JSON

Source: https://github.com/streamelements/widgets/blob/master/docs/WidgetStructure.md

A comprehensive JSON configuration defining various input types, including text, checkbox, colorpicker, number, slider, dropdown, media inputs, and reserved widget properties.

```JSON
{
  "someText": {
    "type": "text",
    "label": "Some Text",
    "value": "Default text"
  },
  "someCheckbox": {
    "type": "checkbox",
    "label": "Some checkbox"
  },
  "someColorPicker": {
    "type": "colorpicker",
    "label": "Some color",
    "value": "#0000FF"
  },
  "someNumber": {
    "type": "number",
    "label": "Count",
    "value": 10,
    "min": 0,
    "max": 100,
    "step": 1
  },
  "someSlider": {
    "type": "slider",
    "label": "Counter",
    "value": 10,
    "min": 0,
    "max": 100,
    "step": 1
  },
  "someDropdown": {
    "type": "dropdown",
    "label": "Choose an option:",
    "value": "blue",
    "options": {
      "blue": "Blue thing",
      "apple": "Some apple",
      "7": "Lucky number"
    }
  },
  "someImage": {
     "type": "image-input",
     "label": "Some Image"
   },
 "someVideo": {
   "type": "video-input",
   "label": "Some Video"
 },
 "someSound": {
   "type": "sound-input",
   "label": "Some Audio"
 },
  "fontName": {
      "type": "googleFont",
      "label": "Select a font:",
      "value": "Roboto"
    },
  "someButton": {
    "type": "button",
    "label": "Click me!",
    "value": "Thanks"
  },
  "widgetName": {
    "type": "hidden",
    "value": "My Custom Widget"
  },
  "widgetDuration": {
      "type": "hidden",
      "value": 15
    }
}
```

--------------------------------

### Handle session updates

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Listens for 'onSessionUpdate' to access session data. Note that 'onEventReceived' is generally recommended for better performance and ease of implementation.

```javascript
window.addEventListener('onSessionUpdate', function (obj) {
    const data = obj.detail.session;
    //fancy stuff here
});
```

--------------------------------

### Access Tip Recent Properties

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Access the amount of tip for tip events.

```javascript
["amount"]; // amount of tip
```

--------------------------------

### Update top donator and cheerer via session update

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Updates DOM elements with top donator and top cheerer information retrieved from the session data.

```javascript
window.addEventListener('onSessionUpdate', function (obj) {
    const data = obj.detail.session;
     $("#top-donator").text(data["tip-session-top-donator"]["name"]+" - "+data["tip-session-top-donator"]["amount"]);
      $("#top-cheerer").text(data["cheer-session-top-donator"]["name"]+" - " +data["cheer-session-top-donator"]["amount"]);
});
```

--------------------------------

### Handle bot counter events

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Listens for 'bot:counter' events to update the DOM element with the specified counter ID.

```javascript
window.addEventListener('onEventReceived', function (obj) {
    const listener = obj.detail.listener;
    const data = obj.detail.event;

    if (listener === 'bot:counter' && data.counter === counter) {
        document.getElementById("mycounter").innerHTML=data.value;
    }
});
```

--------------------------------

### Access Cheer Recent Properties

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Access the amount of bits for cheer events.

```javascript
["amount"]; // amount of bits
```

--------------------------------

### JavaScript exit animation timer

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomCodeInAlertbox.md

JavaScript logic to trigger an exit animation based on the widget duration.

```js
const hideAfter=parseInt("{widgetDuration}")-1000;
const playHideAnimation=()=>{
  timeline.reverse(); //or any other thing that will make your alert fancy exit
}
setTimeout(playHideAnimation,hideAfter);
```

--------------------------------

### onEventReceived

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

The primary event listener for receiving live widget events. It provides an object containing the event listener type and the associated event data.

```APIDOC
## Event Listener: onEventReceived

### Description
Registers a callback function to handle incoming events such as followers, subscribers, chat messages, and widget interactions.

### Signature
`window.addEventListener('onEventReceived', function (obj) { ... });`

### Parameters
- **obj** (Object) - The event object containing details about the trigger.
  - **obj.detail.listener** (String) - The type of event (e.g., 'follower-latest', 'message', 'delete-message').
  - **obj.detail.event** (Object) - The payload containing specific event data (e.g., name, amount, message).

### Event Types
- **follower-latest**: New Follower
- **subscriber-latest**: New Subscriber
- **host-latest**: New host
- **cheer-latest**: New cheer
- **tip-latest**: New tip
- **raid-latest**: New raid
- **message**: New chat message received
- **delete-message**: Chat message removed (requires msgId)
- **delete-messages**: Chat messages by userId removed
- **event:skip**: User clicked "skip alert"
- **alertService:toggleSound**: User clicked "mute/unmute alerts"
- **bot:counter**: Update of bot counter
- **kvstore:update**: Update of SE_API store value
- **widget-button**: User clicked custom field button
```

--------------------------------

### Access Subscriber Recent Properties

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Access subscriber-specific properties like tier and amount.

```javascript
["tier"]; //Subscriber tier (1000,2000,3000)
["amount"]; // amount of months
```

--------------------------------

### Access onWidgetLoad event data

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Extracts specific session, channel, and field data from the event object for easier access within the widget.

```javascript
window.addEventListener('onWidgetLoad', function (obj) {
    let data=obj["detail"]["session"]["data"];
    let recents=obj["detail"]["recents"];
    let currency=obj["detail"]["currency"];
    let channelName=obj["detail"]["channel"]["username"];
    let apiToken=obj["detail"]["channel"]["apiToken"];
    let fieldData=obj["detail"]["fieldData"];
});
```

--------------------------------

### CSS animation delay

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomCodeInAlertbox.md

CSS configuration to delay an alertbox hide animation based on widget duration.

```css
#alertbox {
  animation: hide forwards 1s;
  animation-delay: calc({widgetDuration}s - 1s);
}
```

--------------------------------

### kvstore:update Event Payload

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

The structure of the event payload emitted by SE_API.store.set when received by a Custom Widget.

```json
{
	"detail": {
		"listener": "kvstore:update",
		"event": {
			"data": {
				"key": "customWidget.keyName",
				"value": {
					"array": [
						33,
						"foobar"
					],
					"date": "2021-03-15T08:46:10.919Z",
					"test": 15
				}
			}
		}
	}
}
```

--------------------------------

### onSessionUpdate

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Triggered when session data is updated, providing comprehensive information about session statistics like top donators or cheerers.

```APIDOC
## Event: onSessionUpdate

### Description
Triggered every time session data is updated (e.g., new tip, cheer, or follower). It provides a detailed session object containing aggregated data.

### Event Data
- **session** (object) - Contains session-wide statistics such as 'tip-session-top-donator' and 'cheer-session-top-donator'.

### Example
```javascript
window.addEventListener('onSessionUpdate', function (obj) {
    const data = obj.detail.session;
    $("#top-donator").text(data["tip-session-top-donator"]["name"]+" - "+data["tip-session-top-donator"]["amount"]);
});
```
```

--------------------------------

### Access Raid Recent Properties

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Access the amount of months for raid events.

```javascript
["amount"]; // amount of months
```

--------------------------------

### SE_API.sanitize

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Validates a message against content rules.

```APIDOC
## SE_API.sanitize(data)

### Description
Validates a message. Returns a promise that resolves with an object containing the sanitized result and a skip flag.

### Parameters
- **data** (object) - Required - Object containing the message to sanitize.
```

--------------------------------

### Message event data structure

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

The JSON structure of the data object accessible at obj.detail.event.data for chat message events.

```json
{
  "time": 1552400352142,
  "tags": {
    "badges": "broadcaster/1",
    "color": "#641FEF",
    "display-name": "SenderName",
    "emotes": "25:5-9",
    "flags": "",
    "id": "885d1f33-8387-4206-a668-e9b1409a998b",
    "mod": "0",
    "room-id": "85827806",
    "subscriber": "0",
    "tmi-sent-ts": "1552400351927",
    "turbo": "0",
    "user-id": "85827806",
    "user-type": ""
  },
  "nick": "sendername",
  "userId": "123123",
  "displayName": "senderName",
  "displayColor": "#641FEF",
  "badges": [
    {
      "type": "broadcaster",
      "version": "1",
      "url": "https://static-cdn.jtvnw.net/badges/v1/5527c58c-fb7d-422d-b71b-f309dcb85cc1/3",
      "description": "Broadcaster"
    }
  ],
  "channel": "channelname",
  "text": "Test Kappa test",
  "isAction": false,
  "emotes": [
    {
      "type": "twitch",
      "name": "Kappa",
      "id": "25",
      "gif": false,
      "urls": {
        "1": "https://static-cdn.jtvnw.net/emoticons/v1/25/1.0",
        "2": "https://static-cdn.jtvnw.net/emoticons/v1/25/2.0",
        "4": "https://static-cdn.jtvnw.net/emoticons/v1/25/4.0"
      },
      "start": 5,
      "end": 9
    }
  ],
  "msgId": "885d1f33-8387-4206-a668-e9b1409a99Xb"
}
```

--------------------------------

### SE_API.setField

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Updates a field in the widget's fieldData.

```APIDOC
## SE_API.setField(key, value)

### Description
Sets a value in the widget's fieldData. Note: This does not persist automatically; it is intended for use in Editor Mode.

### Parameters
- **key** (string) - Required - The field key.
- **value** (any) - Required - The value to set.
```

--------------------------------

### Access Recent Events

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Access the recent events array for various event types using the data object.

```javascript
data["follower-recent"];
data["subscriber-recent"];
data["host-recent"];
data["raid-recent"];
data["cheer-recent"];
data["tip-recent"];
```

--------------------------------

### Access Recent Event Properties

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidgetEvents.md

Retrieve specific properties from a recent event object, such as the username, timestamp, and event type.

```javascript
let recentFollows=data["follower-recent"][0]; 
recentFollows["name"]; // Username,
recentFollows["createdAt"];// Timestamp like "2018-06-11T08:08:33.180Z",
recentFollows["$hashKey"]; // unique ID for example"object:5024",
recentFollows["type"]; // Event type "follower", "subscriber", "host", "raid", "cheer", "tip"
```

--------------------------------

### SE_API.cheerFilter

Source: https://github.com/streamelements/widgets/blob/master/docs/CustomWidget.md

Removes cheer emotes from a message string.

```APIDOC
## SE_API.cheerFilter(message)

### Description
Filters out cheers from the provided message string. Returns a promise that resolves with the filtered message.

### Parameters
- **message** (string) - Required - The message to filter.
```
Tokens:
Raw