Skip to content

Commit451/skyhook

Repository files navigation

skyhook

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

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 discord.com in url with skyhookapi.com
https://discord.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook
->
https://skyhookapi.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook
  1. Add the provider you want to the end of the url:
https://skyhookapi.com/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 build:

npm run build

To run server (after building):

npm start

To do both:

npm run buildstart

To run tests:

npm test

Through Docker:

docker run -it --rm -p 8080:8080 commit451/skyhook

Web

If you are looking for the frontend web version of skyhook which lets you generate a properly formatted URL, it lives here. This repo/project just includes the backend service.

Deploying

Thanks

Special thanks to all our amazing contributors. skyhookapi.com is hosted for free for you, so if you feel so inclined, buy a coffee!

License

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

\ ゜o゜)ノ