https://github.com/kiss-my/webhook-transfer

A dead-simple Express.js server to forward a single POST payload to an unlimited number of webhooks.
https://github.com/kiss-my/webhook-transfer

discord gitlab proxy slack webhook

Last synced: 3 days ago
JSON representation

A dead-simple Express.js server to forward a single POST payload to an unlimited number of webhooks.

• Host: GitHub
• URL: https://github.com/kiss-my/webhook-transfer
• Owner: kiss-my
• License: mit
• Created: 2020-04-18T17:08:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T12:42:36.000Z (about 2 years ago)
• Last Synced: 2024-11-06T01:06:03.842Z (about 2 months ago)
• Topics: discord, gitlab, proxy, slack, webhook
• Language: JavaScript
• Size: 210 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Webhook Transfer

A dead-simple Express.js server to forward a single POST payload to an unlimited number of webhooks.

## What it does

Here at *kiss my*, we use it for our GitLab (on-premise) / Slack / Discord integrations: GitLab's Discord integration sends really badly formatted messages like this one:  

![result with gitlab discord integration](docs/gitlab-discord.png) 

while using the Slack integration + a Slack formatted webhook in Discord (by adding `/slack` to the webhook's URL) looks like this:  

![result with gitlab slack integration](docs/gitlab-discord-slack.png)

Much more useful!

**It's also very useful to easily send Slack notifications from a single project to an unlimited number of Slack workspaces :)**

## How it works

Instead of having only one URL per GitLab integration, you hit `/relay` on this server's hostname and pass multiple webhook URLs in the `urls[]` query param.  

So if you have say 2 webhooks:  

* `https://hooks.slack.com/some/token`  

* `https://discordapp.com/api/webhooks/some/other/token/slack` (the `/slack` part is mandatory to use the Slack integration)

And you've deployed this app to `https://my-webhook-proxy.example.com`

Now follow these steps:  

* Convert those two webhook URLs to URL parameters. You can do so using [the great URLencoder free tool](https://www.urlencoder.org/), or any other tool.  

* Use the encoded webooks in the query string to the Transfer app: `https://my-webhook-proxy.example.com/relay?urls[]=encodedURL1&urls[]=encodedURL2` *(a free Web tool to make it even easier will be deployed soon)*  

* Paste this new URL as the webhook URL for the Slack integration.  

* Do anything that triggers a notification (you can test it when saving the integration settings)    

* Enjoy!  

## Deployment

* Run the server using `yarn start` or use the Docker image `kissmy/webhook-transfer`  

## Disclaimer

This app works if your webhook works, so please test your endpoints before raising an issue.  

It's not thoroughly tested nor has any kind of error handling (might have in the future if someone else than us uses it).  

It is provided "as is" but may evolve into something more robust if specific use cases arise in the future.

## Contribute

Issues, PR's and enhancement ideas are welcome. While this project suits us for our current usage, we're doing our 

best to be reactive to any activity in this repository.  

There's no code of conduct, just common sense and respect to other people when you collaborate on this repo like  

you'd do with your barber or in a shop. Being "anonymous" on the Web doesn't excuse anyone for being a jerk. 

## License

MIT