Skip to content

Latest commit

 

History

History
121 lines (89 loc) · 4.58 KB

File metadata and controls

121 lines (89 loc) · 4.58 KB

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 and send a test notification to Discord before configuring your provider. If you want to manually create the link, 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

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.

To generate a registered provider, canonical fixture, and focused test in one step:

npm run provider:new -- newprovider NewProvider "New Provider" https://docs.example.com/webhooks

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

Deploying

License

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

\ ゜o゜)ノ