webhook

A webhook to forward GitHub events to StreamLabs Alerts and Twitch Chat.

Deploy to Heroku

Manual deploy

git clone https://github.com/streamdevs/webhook.git
cd webhook
yarn
yarn start

Configuration

We make use of the following environment variables:

Variable	Setting	Mandatory	Default
PORT	Where the HTTP server should listen.	No	8080
STREAMLABS_TOKEN	A token to use the StreamLabs API. You can get one by using StreamDevs/streamlabs-token	Yes	empty
TWITCH_BOT_NAME	The account (username) that the chatbot uses to send chat messages.	Yes	empty
TWITCH_BOT_TOKEN	The token to authenticate your chatbot. Generate this with https://twitchapps.com/tmi/, while logged in to your chatbot account. The token will be an alphanumeric string.	Yes	empty
TWITCH_BOT_CHANNEL	The Twitch channel name where you want to run the bot. Usually this is your main Twitch account.	Yes	empty
NOTIFY_ISSUES_ASSIGNED_TO	A comma-separated list of GitHub user names. Only issues assigned to these users will be notified or leave it empty to receive all notifications.	No	empty array
IGNORE_PR_OPENED_BY	A comma-separated list of GitHub user names. Only PR not opened by these users will be notified or leave it empty to receive all notifications.	No	empty array
NOTIFY_CHECK_RUNS_FOR	Comma-separated list of branches to notify Check Runs for. Leave empty to notify for any branch	No	empty array

How to configure the webhook in GitHub

For sponsorships

Check the GitHub documentation

Contributing

Everyone is welcome to contribute to this repository. To do so follow these steps:

• Open an Issue with your idea and label it using the idea tag
• Open a pull request and reference your original issue
• Make sure your PR includes proper tests
• Be on the lookout for requested changes or clarifications during the Code Review
• Once your PR is reviewed and merged, we'll add you to the contributors list

Deploying to Heroku

You can use the "deploy to Heroku" button link at the top of this readme file or use the Heroku CLI

Configuring your local repo to deploy on Heroku

• Install the Heroku CLI
• Log in to Heroku with heroku login
• Open the Heroku dashboard for your app
• Go to the settings tab
• Under App Information, copy the Heroku git Url
• Add a new git remote with git remote add heroku your-https-git-repo-goes-here

Deploying changes to a Heroku app using the CLI

Push to the master branch on Heroku with git push heroku master

Note that you can deploy a different branch to Heroku, but it will only deploy the remote master branch. To deploy a local branch you can run git push heroku your-branch-here:master so that your branch overrides the master branch on Heroky.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Orestes Carracedo 💻

Santi 💻

hugolesta 💻

Hugo Perez Fernandez 💻

This project follows the all-contributors specification. Contributions of any kind welcome!