Trigger a custom alert for the authenticated user.

📘

Default Values

If any of the optional parameters are not supplied, they will default to the settings the user has selected in the Streamlabs dashboard for the supplied alert type.

Body Params
string
required

This parameter determines which alert box this alert will show up in, and thus should be one of the following: follow, subscription, donation, or host

string

The href pointing to an image resource to play when this alert shows. If an empty string is supplied, no image will be displayed.

string

The href pointing to a sound resource to play when this alert shows. If an empty string is supplied, no sound will be played.

string

The message to show with this alert. If not supplied, no message will be shown. Surround special tokens with *s, for example: This is my *special* alert!

int32

How many seconds this alert should be displayed. Value should be in milliseconds.Ex: 1000 for 1 second

string

The color to use for special tokens. Must be a valid CSS color string.

Responses

Language
Credentials
Request
Choose an example:
application/json