Repository files navigation

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

This is a tool created with live-coding streamers in mind. The goal is to have another source ofinteraction and showcase relevant activity on GitHub to their audience on streaming platformsgenerating more interest in their Open Source projects.

We support the following events:

• Stars
• Forks
• Releases
• Issues
  • Opened
  • Assigned
• Pull Requests
  • Opened
  • Merged

At the moment GitLab's webhooks don't support as many events. So far, we support:

• Merge Request
  • Opened
  • Merged

There are a few requirements for the integration to work.

• Your webhook is on a server, running 24/7
• Your webhook is able to receive HTTP requests from GitHub/GitLab.
• Your repository (and/or user/organisation) on GitHub/GitLab is configured to notify yourwebhook

You can deploy this webhook in different ways

0. Get the source code

   git clone https://github.com/streamdevs/webhook.git

1. Change into the source code directory

   cd webhook

2. Install the dependencies with yarn (or alternative you can usenpm)

   yarn install

3. Create a .env file with your (configuration)[#configuration] and the edit it

   cp .env.example .env

4. Compile the project to JavaScript

   yarn build

5. Run the start command

   yarn run start

6. You should see your webhook running on the port specified in the configuration below

We make use of the following environment variables:

0. Open your repository settings on GitHub.
1. Go to theWebhooks section.
2. Click onAdd webhook.
3. On thePayload field, enter the GitHub endpoint for your deployed webhook. For examplehttps://YOUR-SITE-HERE.herokuapp.com/github.
4. ForContent type we want to selectapplication/json.
5. OnWhich events would you like to trigger this webhook? selectLet me select individual events.
6. On the list of events check any of thesupported events
7. Make sure theActive checkbox is checked
8. Click onAdd webhook
9. You will receive your first notification on Twitch Chat and StreamLabs letting you now your webhook has been configured correctly.

Check the GitHub documentation

0. Open your repository settings on GitLab.
1. Go to theSettings/Webhooks section.
2. On theURL field, enter the GitLab endpoint for your deployed webhook. For examplehttps://YOUR-SITE-HERE.herokuapp.com/gitlab.
3. On the list ofTrigger you can activate any of thesupported events
4. Click onAdd webhook

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

• Open anIssue with your idea and label it using theidea tag
• Open apull 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 tothe contributors list

You can use the "deploy to Heroku" button or use the Heroku CLI

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

Push to the master branch on Heroku withgit push heroku master

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

Thanks goes to these wonderful people (emoji key):

Orestes Carracedo 💻

Santi 💻

hugolesta 💻

Hugo Perez Fernandez 💻

riolcrt 🤔

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

This project is under theCC-BY 4.0 license