Streamlabs
App · 17 actions
Read donations, alerts and loyalty points; control alert queues, tip jars, profiles, credits and wheels.
Actions
| Action | What it does |
|---|---|
| Activate alert profile | Activate alert profile. |
| Create donation | Create donation. |
| Empty tip jar | Empty tip jar. |
| Get alert status | Get alert status. |
| Get current user | Get current user. |
| Get points | Get points. |
| List alert profiles | List alert profiles. |
| List donations | List donations. |
| Mute alerts | Mute alerts. |
| Pause alert queue | Pause alert queue. |
| Resume alert queue | Resume alert queue. |
| Roll credits | Roll credits. |
| Send alert | Send alert. |
| Skip alert | Skip alert. |
| Spin wheel | Spin wheel. |
| Subtract points | Subtract points. |
| Unmute alerts | Unmute alerts. |
Activate alert profile
Activate alert profile.
Inputs
- Profile ID
profile_idtextRequired - Profile id.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Create donation
Create donation.
Inputs
- Name
nametextRequired - Name.
- Identifier
identifiertextRequired - Identifier.
- Amount
amountnumberRequired - Amount.At least 0.01.
- Currency
currencytextRequired - Currency.
- Message
messagetext - Message.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {
"donation_id": 0
},
"has_more": false,
"next_cursor": null
}Empty tip jar
Empty tip jar.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get alert status
Get alert status.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get current user
Get current user.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get points
Get points.
Inputs
- Channel
channeltextRequired - Channel.
- Username
usernametextRequired - Username.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List alert profiles
List alert profiles.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List donations
List donations. Returns one page; use next_cursor to continue.
Inputs
- Before donation
beforetext - Leave empty for newest donations; use next_cursor to continue to older donations.
- Results per page
limitnumber - Maximum records in this page. Leave empty for the service default.From 1 to 100.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Mute alerts
Mute alerts.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Pause alert queue
Pause alert queue.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Resume alert queue
Resume alert queue.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Roll credits
Roll credits.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Send alert
Send alert.
Inputs
- Type
typetextRequired - Type.One of:
follow,subscription,donation,host. - Message
messagetextRequired - Message.
- Duration
durationnumber - Duration.From 1 to 300.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Skip alert
Skip alert.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Spin wheel
Spin wheel.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Subtract points
Subtract points.
Inputs
- Channel
channeltextRequired - Channel.
- Username
usernametextRequired - Username.
- Points
pointsnumberRequired - Points.At least 1.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Unmute alerts
Unmute alerts.
Inputs
None.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}