Streamlabs

App · 17 actions

Read donations, alerts and loyalty points; control alert queues, tip jars, profiles, credits and wheels.

Actions

ActionWhat it does
Activate alert profileActivate alert profile.
Create donationCreate donation.
Empty tip jarEmpty tip jar.
Get alert statusGet alert status.
Get current userGet current user.
Get pointsGet points.
List alert profilesList alert profiles.
List donationsList donations.
Mute alertsMute alerts.
Pause alert queuePause alert queue.
Resume alert queueResume alert queue.
Roll creditsRoll credits.
Send alertSend alert.
Skip alertSkip alert.
Spin wheelSpin wheel.
Subtract pointsSubtract points.
Unmute alertsUnmute alerts.

Activate alert profile

Activate alert profile.

Inputs

Profile IDprofile_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

NamenametextRequired
Name.
IdentifieridentifiertextRequired
Identifier.
AmountamountnumberRequired
Amount.At least 0.01.
CurrencycurrencytextRequired
Currency.
Messagemessagetext
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

ChannelchanneltextRequired
Channel.
UsernameusernametextRequired
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 donationbeforetext
Leave empty for newest donations; use next_cursor to continue to older donations.
Results per pagelimitnumber
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

TypetypetextRequired
Type.One of: follow, subscription, donation, host.
MessagemessagetextRequired
Message.
Durationdurationnumber
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

ChannelchanneltextRequired
Channel.
UsernameusernametextRequired
Username.
PointspointsnumberRequired
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
}

On this page