/skyhook

Parses webhooks and forwards them in the proper format to Discord.

Primary LanguageTypeScriptMIT LicenseMIT

skyhook

Parses webhooks and forwards them in the proper format to Discord.

Build Status Discord

Setup

You can use the site to create the right webhook link. If you want to manually do it, here are the steps:

  1. Create a webhook in Discord (Server Settings -> Webhooks -> Create Webhook)
  2. Copy the webhook url
  3. Turn the Discord webhook url into a skyhook webhook url like so:
Replace discordapp.com in url with skyhook.glitch.me
https://discordapp.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook
->
https://skyhook.glitch.me/api/webhooks/firstPartOfWebhook/secondPartOfWebhook
  1. Add the provider you want to the end of the url:
https://skyhook.glitch.me/api/webhooks/firstPartOfWebhook/secondPartOfWebhook/providerGoesHere

Supported Providers

If you want support for a new provider, just create a pull request and add it!
Alternatively, a new provider can also be requested by creating an issue.

Contributing

If you wish to contribute, follow our contributing guide.

Creating a Provider

If you want to create a new provider please follow the examples shown at our small documentation.

Testing Locally

To run server:

npm start

To run tests:

npm test

Running with Docker

To build the image:

docker build -t skyhook .

To run the application:

docker run -p 8080:8080 --name skyhook skyhook

To run the tests:

docker run --name skyhook skyhook npm test

To remove the created container:

docker rm skyhook

License

skyhook is available under the MIT license. See the LICENSE file for more info.

\ ゜o゜)ノ