From 1d64772d299d8308e54cc4add0d490d64fa45d91 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sun, 5 Sep 2021 15:02:19 -0400 Subject: [PATCH] Created Notify_streamlabs (markdown) --- Notify_streamlabs.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 Notify_streamlabs.md diff --git a/Notify_streamlabs.md b/Notify_streamlabs.md new file mode 100644 index 0000000..a5900fe --- /dev/null +++ b/Notify_streamlabs.md @@ -0,0 +1,42 @@ +## Streamlabs Notifications +* **Source**: https://streamlabs.com/ +* **Icon Support**: Yes +* **Message Format**: Text +* **Message Limit**: 32768 Characters per message + +### Account Setup +The process to get signed up with Streamlabs is a bit lengthy. + +**Note:** The screenshots and instructions below are 100% full credit to the **[LNBits Project](https://github.com/Fittiboy/lnbits)** ([found here](https://github.com/Fittiboy/lnbits/tree/master/lnbits/extensions/streamalerts#stream-alerts)). + +At the moment, the only service that has an open API to work with is Streamlabs, so this setup requires linking your Twitch/YouTube/Facebook account to Streamlabs. + +1. Log into [Streamlabs](https://streamlabs.com/login?r=https://streamlabs.com/dashboard). +1. Navigate to the API settings page to register an App: +![image](https://user-images.githubusercontent.com/28876473/127759145-710d53b6-3c19-4815-812a-9a6279d1b8bb.png) +![image](https://user-images.githubusercontent.com/28876473/127759182-da8a27cb-bb59-48fa-868e-c8892080ae98.png) +![image](https://user-images.githubusercontent.com/28876473/127759201-7c28e9f1-6286-42be-a38e-1c377a86976b.png) +1. Fill out the form with anything it will accept as valid. Most fields can be gibberish, as the application is not supposed to ever move past the "testing" stage and is for your personal use only. +In the "Whitelist Users" field, input the username of a Twitch account you control. While this feature is *technically* limited to Twitch, you can use the alerts overlay for donations on YouTube and Facebook as well. +For now, simply set the "Redirect URI" to `http://localhost`, you will change this soon. +Then, hit create: +![image](https://user-images.githubusercontent.com/28876473/127759264-ae91539a-5694-4096-a478-80eb02b7b594.png) +1. Create a "NEW SERVICE" using the button. Fill in all the information (you get your Client ID and Secret from the Streamlabs App page): +![image](https://user-images.githubusercontent.com/28876473/127759512-8e8b4e90-2a64-422a-bf0a-5508d0630bed.png) + +### Syntax +Valid syntax is as follows: +* `strmlabs://{access_token}/` + +### Parameter Breakdown +| Variable | Required | Description +| ------------ | -------- | ----------- +| access_token | Yes |The access token generated from your Streamlabs account. + +#### Example +Send a streamlabs notification: +```bash +# Assuming our {access_token} is abcdefghij1234567890 +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + strmlabs:///abcdefghij1234567890/ +``` \ No newline at end of file