mirror of
https://github.com/opelly27/streetmerchant.git
synced 2026-05-20 13:27:38 +00:00
1489 lines
44 KiB
HTML
1489 lines
44 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="🤖 The world's easiest, most powerful stock checker">
|
|
|
|
|
|
|
|
<meta name="author" content="Jef LeCompte">
|
|
|
|
|
|
<link rel="canonical" href="https://jef.codes/streetmerchant/reference/notification/">
|
|
|
|
<link rel="shortcut icon" href="https://raw.githubusercontent.com/jef/streetmerchant/main/docs/assets/images/streetmerchant-logo.png">
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.4">
|
|
|
|
|
|
|
|
<title>Notification - streetmerchant</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.77f3fd56.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.7fa14f5b.min.css">
|
|
|
|
|
|
|
|
<meta name="theme-color" content="#4051b5">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CFira+Code&display=fallback">
|
|
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Fira Code"}</style>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Open Graph -->
|
|
<meta property="og:type" content="website" />
|
|
<meta property="og:title" content="streetmerchant - Notification" />
|
|
<meta property="og:description" content="🤖 The world's easiest, most powerful stock checker" />
|
|
<meta property="og:url" content="https://jef.codes/streetmerchant/reference/notification/" />
|
|
<meta property="og:image" content="https://jef.codes/streetmerchant/assets/images/streetmerchant-github.png" />
|
|
<meta property="og:image:type" content="image/png" />
|
|
<meta property="og:image:width" content="1280" />
|
|
<meta property="og:image:height" content="640" />
|
|
|
|
<!-- Twitter -->
|
|
<meta name="twitter:card" content="summary_large_image" />
|
|
<meta name="twitter:site" content="@hijxf" />
|
|
<meta name="twitter:creator" content="@hijxf" />
|
|
<meta name="twitter:title" content="streetmerchant - Notification" />
|
|
<meta name="twitter:description" content="🤖 The world's easiest, most powerful stock checker" />
|
|
<meta name="twitter:image" content="https://jef.codes/streetmerchant/assets/images/streetmerchant-github.png" />
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
|
|
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#notification" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="https://jef.codes/streetmerchant" title="streetmerchant" class="md-header__button md-logo" aria-label="streetmerchant">
|
|
|
|
<img src="../../assets/images/streetmerchant-logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
streetmerchant
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Notification
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="md-header__options">
|
|
|
|
</div>
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
</label>
|
|
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</label>
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
</button>
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
|
|
<a href="https://github.com/jef/streetmerchant/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 11c-.69 0-1.25.56-1.25 1.25v1.5a1.25 1.25 0 1 0 2.5 0v-1.5C9 11.56 8.44 11 7.75 11zm1.27 4.5a.469.469 0 0 1 .48-.5h5a.47.47 0 0 1 .48.5c-.116 1.316-.759 2.5-2.98 2.5s-2.864-1.184-2.98-2.5zm7.23-4.5c-.69 0-1.25.56-1.25 1.25v1.5a1.25 1.25 0 1 0 2.5 0v-1.5c0-.69-.56-1.25-1.25-1.25z"/><path fill-rule="evenodd" d="M21.255 3.82a1.725 1.725 0 0 0-2.141-1.195c-.557.16-1.406.44-2.264.866-.78.386-1.647.93-2.293 1.677A18.442 18.442 0 0 0 12 5c-.93 0-1.784.059-2.569.17-.645-.74-1.505-1.28-2.28-1.664a13.876 13.876 0 0 0-2.265-.866 1.725 1.725 0 0 0-2.141 1.196 23.645 23.645 0 0 0-.69 3.292c-.125.97-.191 2.07-.066 3.112C1.254 11.882 1 13.734 1 15.527 1 19.915 3.13 23 12 23c8.87 0 11-3.053 11-7.473 0-1.794-.255-3.647-.99-5.29.127-1.046.06-2.15-.066-3.125a23.652 23.652 0 0 0-.689-3.292zM20.5 14c.5 3.5-1.5 6.5-8.5 6.5s-9-3-8.5-6.5c.583-4 3-6 8.5-6s7.928 2 8.5 6z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
jef/streetmerchant
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="https://jef.codes/streetmerchant" title="streetmerchant" class="md-nav__button md-logo" aria-label="streetmerchant">
|
|
|
|
<img src="../../assets/images/streetmerchant-logo.png" alt="logo">
|
|
|
|
</a>
|
|
streetmerchant
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
<a href="https://github.com/jef/streetmerchant/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 11c-.69 0-1.25.56-1.25 1.25v1.5a1.25 1.25 0 1 0 2.5 0v-1.5C9 11.56 8.44 11 7.75 11zm1.27 4.5a.469.469 0 0 1 .48-.5h5a.47.47 0 0 1 .48.5c-.116 1.316-.759 2.5-2.98 2.5s-2.864-1.184-2.98-2.5zm7.23-4.5c-.69 0-1.25.56-1.25 1.25v1.5a1.25 1.25 0 1 0 2.5 0v-1.5c0-.69-.56-1.25-1.25-1.25z"/><path fill-rule="evenodd" d="M21.255 3.82a1.725 1.725 0 0 0-2.141-1.195c-.557.16-1.406.44-2.264.866-.78.386-1.647.93-2.293 1.677A18.442 18.442 0 0 0 12 5c-.93 0-1.784.059-2.569.17-.645-.74-1.505-1.28-2.28-1.664a13.876 13.876 0 0 0-2.265-.866 1.725 1.725 0 0 0-2.141 1.196 23.645 23.645 0 0 0-.69 3.292c-.125.97-.191 2.07-.066 3.112C1.254 11.882 1 13.734 1 15.527 1 19.915 3.13 23 12 23c8.87 0 11-3.053 11-7.473 0-1.794-.255-3.647-.99-5.29.127-1.046.06-2.15-.066-3.125a23.652 23.652 0 0 0-.689-3.292zM20.5 14c.5 3.5-1.5 6.5-8.5 6.5s-9-3-8.5-6.5c.583-4 3-6 8.5-6s7.928 2 8.5 6z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
jef/streetmerchant
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../.." class="md-nav__link">
|
|
Home
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/" class="md-nav__link">
|
|
Getting started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
|
|
|
|
<label class="md-nav__link" for="__nav_3">
|
|
Reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Reference" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../application/" class="md-nav__link">
|
|
Application
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../filter/" class="md-nav__link">
|
|
Filter
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
Notification
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
Notification
|
|
</a>
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#desktop" class="md-nav__link">
|
|
Desktop
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#discord" class="md-nav__link">
|
|
Discord
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#email-and-sms" class="md-nav__link">
|
|
Email and SMS
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Email and SMS">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#supported-carriers" class="md-nav__link">
|
|
Supported carriers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#mqtt" class="md-nav__link">
|
|
MQTT
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pagerduty" class="md-nav__link">
|
|
PagerDuty
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#philips-hue" class="md-nav__link">
|
|
Philips Hue
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pushbullet" class="md-nav__link">
|
|
Pushbullet
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pushover" class="md-nav__link">
|
|
Pushover
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#redis" class="md-nav__link">
|
|
Redis
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#slack" class="md-nav__link">
|
|
Slack
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#smartthings" class="md-nav__link">
|
|
SmartThings
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#telegram" class="md-nav__link">
|
|
Telegram
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#twilio" class="md-nav__link">
|
|
Twilio
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#twitter" class="md-nav__link">
|
|
Twitter
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#twitch" class="md-nav__link">
|
|
Twitch
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#streamlabs" class="md-nav__link">
|
|
StreamLabs
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../proxy/" class="md-nav__link">
|
|
Proxy
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../terraform/" class="md-nav__link">
|
|
Terraform
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
|
|
|
|
<label class="md-nav__link" for="__nav_4">
|
|
Help
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Help" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Help
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../help/general/" class="md-nav__link">
|
|
General
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../help/troubleshoot/" class="md-nav__link">
|
|
Troubleshoot
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../faq/" class="md-nav__link">
|
|
FAQ
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../changelog/" class="md-nav__link">
|
|
Changelog
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../about/" class="md-nav__link">
|
|
About
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#desktop" class="md-nav__link">
|
|
Desktop
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#discord" class="md-nav__link">
|
|
Discord
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#email-and-sms" class="md-nav__link">
|
|
Email and SMS
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Email and SMS">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#supported-carriers" class="md-nav__link">
|
|
Supported carriers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#mqtt" class="md-nav__link">
|
|
MQTT
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pagerduty" class="md-nav__link">
|
|
PagerDuty
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#philips-hue" class="md-nav__link">
|
|
Philips Hue
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pushbullet" class="md-nav__link">
|
|
Pushbullet
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pushover" class="md-nav__link">
|
|
Pushover
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#redis" class="md-nav__link">
|
|
Redis
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#slack" class="md-nav__link">
|
|
Slack
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#smartthings" class="md-nav__link">
|
|
SmartThings
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#telegram" class="md-nav__link">
|
|
Telegram
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#twilio" class="md-nav__link">
|
|
Twilio
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#twitter" class="md-nav__link">
|
|
Twitter
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#twitch" class="md-nav__link">
|
|
Twitch
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#streamlabs" class="md-nav__link">
|
|
StreamLabs
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/jef/streetmerchant/edit/master/docs/reference/notification.md" title="Edit this page" class="md-content__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|
</a>
|
|
|
|
|
|
<h1 id="notification">Notification<a class="headerlink" href="#notification" title="Permanent link">¶</a></h1>
|
|
<p>You can test your notification configuration by running <code>npm run test:notification</code>.</p>
|
|
<h2 id="desktop">Desktop<a class="headerlink" href="#desktop" title="Permanent link">¶</a></h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>DESKTOP_NOTIFICATIONS</code></td>
|
|
<td>Display desktop notifications using <a href="https://www.npmjs.com/package/node-notifier">node-notifier</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PLAY_SOUND</code></td>
|
|
<td>Play this sound notification if a product is found. Relative path accepted, valid formats: wav, mp3, flac, E.g.: <code>path/to/notification.wav</code>, <a href="https://notificationsounds.com/">free sounds available</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>SOUND_PLAYER</code></td>
|
|
<td>Override the default sound player using the specified executable.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="attention" open="open"><summary>Attention</summary><p>If you're on Windows, you must have the proper library to run.</p>
|
|
</details>
|
|
<h2 id="discord">Discord<a class="headerlink" href="#discord" title="Permanent link">¶</a></h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP</code></td>
|
|
<td>Discord group you would like to notify</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_3060</code></td>
|
|
<td>Discord group to notify on 3060 stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_3060TI</code></td>
|
|
<td>Discord group to notify on 3060 Ti stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_3070</code></td>
|
|
<td>Discord group to notify on 3070 stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_3080</code></td>
|
|
<td>Discord group to notify on 3080 stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_3090</code></td>
|
|
<td>Discord group to notify on 3090 stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_RYZEN5600</code></td>
|
|
<td>Discord group to notify on 5600X stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_RYZEN5800</code></td>
|
|
<td>Discord group to notify on 5800X stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_RYZEN5900</code></td>
|
|
<td>Discord group to notify on 5900X stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_RYZEN5950</code></td>
|
|
<td>Discord group to notify on 5950X stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_DARKHERO</code></td>
|
|
<td>Discord group to notify on Dark Hero stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_CORSAIR_SF</code></td>
|
|
<td>Discord group to notify on Corsair SF stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_SONYPS5C</code></td>
|
|
<td>Discord group to notify on Sony PS5 stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_SONYPS5DE</code></td>
|
|
<td>Discord group to notify on Sony PS5 Digital stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_XBOXSX</code></td>
|
|
<td>Discord group to notify on Xbox Series X stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_XBOXSS</code></td>
|
|
<td>Discord group to notify on Xbox Series S stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_NOTIFY_GROUP_TEST</code></td>
|
|
<td>Discord group to notify on test stock</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>DISCORD_WEB_HOOK</code></td>
|
|
<td>Discord Web Hook URL. Can be comma separated. Use whole webhook URL</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="note" open="open"><summary>Note</summary><p>All groups can be comma separated. <code>DISCORD_NOTIFY_GROUP</code> is always used if set.</p>
|
|
<ul>
|
|
<li>If you're using a role, please use <code><@&2834729847239842></code></li>
|
|
<li>If you're using a user, please use <code><@2834729847239842></code></li>
|
|
</ul>
|
|
</details>
|
|
<h2 id="email-and-sms">Email and SMS<a class="headerlink" href="#email-and-sms" title="Permanent link">¶</a></h2>
|
|
<p>Default provider is Gmail. If you use a different email provider, you must provide SMTP settings.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>EMAIL_PASSWORD</code></td>
|
|
<td>Email password. (See below for Gmail MFA users)</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>EMAIL_TO</code></td>
|
|
<td>Destination Email. Defaults to username if not set. Can be comma separated</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>EMAIL_USERNAME</code></td>
|
|
<td>Email address</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHONE_CARRIER</code></td>
|
|
<td><a href="#supported-carriers">Supported carriers</a> for SMS. E.g.: <code>att</code> or <code>att,verizon,google</code>, email configuration required. If multiple phone numbers are listed, enter a carrier for each phone number</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHONE_NUMBER</code></td>
|
|
<td>10 digit phone number(s). E.g.: <code>1234567890</code> or <code>1234567890,0987654321,11112223333</code>, email configuration required</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>SMTP_ADDRESS</code></td>
|
|
<td>IP Address or FQDN of SMTP server</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>SMTP_PORT</code></td>
|
|
<td>TCP Port number on which the smtp server is listening for connections. Default: <code>25</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="attention" open="open"><summary>Attention</summary><p>If you use Gmail and have multi-factor authentication (MFA), you will need to create an <a href="https://myaccount.google.com/apppasswords">app password</a> and use this instead of your Gmail password.</p>
|
|
</details>
|
|
<h3 id="supported-carriers">Supported carriers<a class="headerlink" href="#supported-carriers" title="Permanent link">¶</a></h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Carrier</th>
|
|
<th align="center">Environment variable</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center">AT&T</td>
|
|
<td align="center"><code>att</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">AT&T Prepaid</td>
|
|
<td align="center"><code>attgo</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Bell</td>
|
|
<td align="center"><code>bell</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Fido</td>
|
|
<td align="center"><code>fido</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Google</td>
|
|
<td align="center"><code>google</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Koodo</td>
|
|
<td align="center"><code>koodo</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Mint</td>
|
|
<td align="center"><code>mint</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Rogers</td>
|
|
<td align="center"><code>rogers</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Sprint</td>
|
|
<td align="center"><code>sprint</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Telus</td>
|
|
<td align="center"><code>telus</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">T-Mobile</td>
|
|
<td align="center"><code>tmobile</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">USCC</td>
|
|
<td align="center"><code>uscc</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Verizon</td>
|
|
<td align="center"><code>verizon</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Virgin</td>
|
|
<td align="center"><code>virgin</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Virgin (CA)</td>
|
|
<td align="center"><code>virgin-ca</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">Visible</td>
|
|
<td align="center"><code>visible</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="mqtt">MQTT<a class="headerlink" href="#mqtt" title="Permanent link">¶</a></h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>MQTT_BROKER_ADDRESS</code></td>
|
|
<td>IP address or URL of MQTT Broker, e.g.: <code>192.168.1.xxx</code> or <code>broker.hivemq.com</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>MQTT_BROKER_PORT</code></td>
|
|
<td>Network port of MQTT Broker. Default: <code>1883</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>MQTT_CLIENT_ID</code></td>
|
|
<td>Unique Client ID (only if required by MQTT Broker), typically not required when only publishing alerts</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>MQTT_PASSWORD</code></td>
|
|
<td>MQTT password - only use with MQTT brokers on private networks, if required. Will not be sent over public networks for safety</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>MQTT_QOS</code></td>
|
|
<td>QoS level for published alerts to broker (https://www.npmjs.com/package/mqtt#about-qos). Default: <code>0</code>, Can be <code>0</code>, <code>1</code>, or <code>2</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>MQTT_TOPIC</code></td>
|
|
<td>Topic to publish alerts to. Can include <code>%store%</code>, <code>%series%</code>, <code>%brand%</code>, <code>%model%</code> for dynamic topics. Default: <code>streetmerchant/alert</code>. E.g.: <code>nv-alert/%store%/%series%/%brand%/%model%/alert</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>MQTT_USERNAME</code></td>
|
|
<td>MQTT username - (only if required by MQTT Broker)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pagerduty">PagerDuty<a class="headerlink" href="#pagerduty" title="Permanent link">¶</a></h2>
|
|
<p>Obtained in PagerDuty - <Service you want to use> - Integrations</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>PAGERDUTY_INTEGRATION_KEY</code></td>
|
|
<td>PagerDuty Events API v2 Integration Key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PAGERDUTY_SEVERITY</code></td>
|
|
<td>Severity of PagerDuty events</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="philips-hue">Philips Hue<a class="headerlink" href="#philips-hue" title="Permanent link">¶</a></h2>
|
|
<p>Generate required keys using <a href="https://developers.meethue.com/develop/get-started-2/">instructions</a>. This will be used for both LAN and cloud access over the official Remote Hue API.</p>
|
|
<p>For cloud only usage, instructions to generate are located <a href="https://developers.meethue.com/develop/hue-api/remote-authentication/">here</a>.</p>
|
|
<blockquote>
|
|
<p><img alt="👉" class="twemoji" src="https://twemoji.maxcdn.com/v/latest/svg/1f449.svg" title=":point_right:" /> Here's a <a href="https://vimeo.com/476083242">video demonstration</a>.</p>
|
|
</blockquote>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_API_KEY</code></td>
|
|
<td>Hue Bridge API Key</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_LAN_BRIDGE_IP</code></td>
|
|
<td>LAN IP Address of your Hue Bridge. LAN only, e.g. <code>192.168.x.x</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_LIGHT_IDS</code></td>
|
|
<td>Light IDs. All lights if not supplied. Can be comma separated, e.g.: <code>1,2</code>. See Hue App -> About for IDs</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_LIGHT_COLOR</code></td>
|
|
<td>Color in RGB Format. Nvidia green if not supplied. Can be comma separated, e.g.: <code>255,255,255</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_LIGHT_PATTERN</code></td>
|
|
<td>Lights will flash for 30 seconds if <code>blink</code> is given</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_CLOUD_ACCESS_TOKEN</code></td>
|
|
<td>Cloud Access Token. Cloud only</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_CLOUD_REFRESH_TOKEN</code></td>
|
|
<td>Cloud Refresh Token. Cloud only</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_CLOUD_CLIENT_ID</code></td>
|
|
<td>Cloud Client ID. Cloud only</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PHILIPS_HUE_CLOUD_CLIENT_SECRET</code></td>
|
|
<td>Cloud Client Secret. Cloud only</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pushbullet">Pushbullet<a class="headerlink" href="#pushbullet" title="Permanent link">¶</a></h2>
|
|
<p>Generate token at <a href="https://pushbullet.com/#settings/account">pushbullet.com/#settings/account</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>PUSHBULLET</code></td>
|
|
<td>API key</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pushover">Pushover<a class="headerlink" href="#pushover" title="Permanent link">¶</a></h2>
|
|
<p>Generate token at <a href="https://pushover.net/apps/build">pushover.net/apps/build</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>PUSHOVER_EXPIRE</code></td>
|
|
<td>How many seconds your notification will continue to be retried for (every <code>PUSHOVER_RETRY</code> seconds)</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PUSHOVER_RETRY</code></td>
|
|
<td>How often (in seconds) the Pushover servers will send the same notification to the user</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PUSHOVER_PRIORITY</code></td>
|
|
<td>Message priority</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PUSHOVER_TOKEN</code></td>
|
|
<td>API token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>PUSHOVER_USER</code></td>
|
|
<td>Username</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="note" open="open"><summary>Note</summary><p><code>PUSHOVER_EXPIRE</code> and <code>PUSHOVER_RETRY</code> are only used when <code>PUSHOVER_PRIORITY="2"</code></p>
|
|
</details>
|
|
<h2 id="redis">Redis<a class="headerlink" href="#redis" title="Permanent link">¶</a></h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>REDIS_URL</code></td>
|
|
<td>Connection string in format (redis://[username]:[password]@[host][:port]/[database-id]) (redis://localhost:6379/1)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="slack">Slack<a class="headerlink" href="#slack" title="Permanent link">¶</a></h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>SLACK_CHANNEL</code></td>
|
|
<td>Channel for posting</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>SLACK_TOKEN</code></td>
|
|
<td>API token</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="smartthings">SmartThings<a class="headerlink" href="#smartthings" title="Permanent link">¶</a></h2>
|
|
<p>Generate token at <a href="https://account.smartthings.com/tokens">account.smartthings.com/tokens</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>SMARTTHINGS_TOKEN</code></td>
|
|
<td>Access token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>SMARTTHINGS_SWITCH_LABEL</code></td>
|
|
<td>Switch Label of switch to activate</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="telegram">Telegram<a class="headerlink" href="#telegram" title="Permanent link">¶</a></h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>TELEGRAM_ACCESS_TOKEN</code></td>
|
|
<td>Access token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TELEGRAM_CHAT_ID</code></td>
|
|
<td>Chat ID. Can be comma separated, e.g.: <code>123456789,987654321</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="twilio">Twilio<a class="headerlink" href="#twilio" title="Permanent link">¶</a></h2>
|
|
<p>Token generation can be found at <a href="https://twilio.com/console">twilio.com/console</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>TWILIO_ACCOUNT_SID</code></td>
|
|
<td>Account SID</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWILIO_AUTH_TOKEN</code></td>
|
|
<td>Auth Token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWILIO_FROM_NUMBER</code></td>
|
|
<td>Provided phone number to send messages from</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWILIO_TO_NUMBER</code></td>
|
|
<td>Mobile number to send SMS to</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="note" open="open"><summary>Note</summary><p>Include country codes in phone numbers. Example: <code>+4401234567890</code></p>
|
|
</details>
|
|
<h2 id="twitter">Twitter<a class="headerlink" href="#twitter" title="Permanent link">¶</a></h2>
|
|
<p>Generate all Twitter keys at <a href="https://developer.twitter.com">developer.twitter.com</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>TWITTER_ACCESS_TOKEN_KEY</code></td>
|
|
<td>Twitter Token Key</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITTER_ACCESS_TOKEN_SECRET</code></td>
|
|
<td>Twitter Token Secret</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITTER_CONSUMER_KEY</code></td>
|
|
<td>Twitter Consumer Key</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITTER_CONSUMER_SECRET</code></td>
|
|
<td>Twitter Consumer Secret</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITTER_TWEET_TAGS</code></td>
|
|
<td>List of hashtags to append to the tweet message, e.g.: <code>#nvidia #nvidiastock</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="twitch">Twitch<a class="headerlink" href="#twitch" title="Permanent link">¶</a></h2>
|
|
<p>Instructions on how to set up tokens can be found at <a href="https://d-fischer.github.io/twitch-chat-client/docs/examples/basic-bot">d-fischer.github.io/twitch-chat-client/docs/examples/basic-bot</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>TWITCH_CLIENT_ID</code></td>
|
|
<td>Twitch client ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITCH_CLIENT_SECRET</code></td>
|
|
<td>Twitch client secret</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITCH_ACCESS_TOKEN</code></td>
|
|
<td>Twitch access token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITCH_REFRESH_TOKEN</code></td>
|
|
<td>Twitch refresh token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>TWITCH_CHANNEL</code></td>
|
|
<td>Twitch channel</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="streamlabs">StreamLabs<a class="headerlink" href="#streamlabs" title="Permanent link">¶</a></h2>
|
|
<p>Instructions on how to set up tokens can be found at <a href="https://dev.streamlabs.com/docs/register-your-application">dev.streamlabs.com</a>.
|
|
You don't need to submit your application for review, just whitelist yourself!</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="center">Environment variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center"><code>STREAMLABS_ACCESS_TOKEN</code></td>
|
|
<td>StreamLabs access token</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>STREAMLABS_TYPE</code></td>
|
|
<td>StreamLabs alert type</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>STREAMLABS_IMAGE</code></td>
|
|
<td>Custom image to display. Leave it blank for default</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>STREAMLABS_SOUND</code></td>
|
|
<td>Custom image to play. Leave it blank for default</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><code>STREAMLABS_DURATION</code></td>
|
|
<td>StreamLabs alert duration (in milliseconds)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
<div class="md-source-date">
|
|
<small>
|
|
|
|
Last update: 2021-03-04
|
|
|
|
</small>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer">
|
|
|
|
<a href="../filter/" class="md-footer__link md-footer__link--prev" rel="prev">
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
Filter
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../proxy/" class="md-footer__link md-footer__link--next" rel="next">
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
Proxy
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
<div class="md-footer-copyright__highlight">
|
|
Copyright © 2016 - 2020 Jef LeCompte
|
|
</div>
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
</div>
|
|
|
|
<div class="md-footer-social">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/jef" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://twitter.com/hijxf" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://www.linkedin.com/in/jeflecompte" target="_blank" rel="noopener" title="www.linkedin.com" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
<script id="__config" type="application/json">{"base": "../..", "features": ["search.suggest"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fb4a9340.min.js", "version": null}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.9b151c6a.min.js"></script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js"></script>
|
|
|
|
<script src="../../javascripts/tables.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |