/alerts

post

https://streamlabs.com/api/v1.0/alerts

Trigger a custom alert for the authenticated user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
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

type

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

image_href

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.

sound_href

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.

message

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!

duration

int32

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

special_text_color

string

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

Responses

Language

Credentials

Query

Loading…

Response

Choose an example:

application/json

📘Default Values

200200

400400

📘
Default Values