Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commit451/skyhook
Parses webhooks and forwards them in the proper format to Discord.
https://github.com/commit451/skyhook
appveyor bitbucket circleci discord gitlab heroku jenkins patreon pingdom travis-ci trello unity3d webhook
Last synced: about 1 month ago
JSON representation
Parses webhooks and forwards them in the proper format to Discord.
- Host: GitHub
- URL: https://github.com/commit451/skyhook
- Owner: Commit451
- License: mit
- Created: 2017-03-24T14:14:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T19:57:01.000Z (about 2 months ago)
- Last Synced: 2024-10-13T07:41:08.519Z (about 1 month ago)
- Topics: appveyor, bitbucket, circleci, discord, gitlab, heroku, jenkins, patreon, pingdom, travis-ci, trello, unity3d, webhook
- Language: TypeScript
- Homepage: https://commit451.github.io/skyhook-web
- Size: 1.16 MB
- Stars: 367
- Watchers: 17
- Forks: 95
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: License
Awesome Lists containing this project
README
# skyhook
Parses webhooks and forwards them in the proper format to Discord.
[](https://discord.gg/js7wD7p)
## Setup
You can use the [site](https://commit451.github.io/skyhook-web) 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
```
4. Add the provider you want to the end of the url:
```
https://skyhookapi.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook/providerGoesHere
```
## Supported Providers
- [AppCenter](https://learn.microsoft.com/en-us/appcenter/dashboard/webhooks/) - `/appcenter`
- [AppVeyor](https://www.appveyor.com/docs/notifications/#webhook-payload-default) - `/appveyor`
- [Basecamp 3](https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md) - `/basecamp`
- [BitBucket](https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html) - `/bitbucket`
- [BitBucket Server](https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html) - `/bitbucketserver`
- [CircleCI](https://circleci.com/docs/1.0/configuration/#notify) - `/circleci`
- [Codacy](https://support.codacy.com/hc/en-us/articles/207280359-WebHook-Notifications) - `/codacy`
- [Confluence](https://developer.atlassian.com/cloud/confluence/modules/webhook/) - `/confluence`
- [Dockerhub](https://docs.docker.com/docker-hub/webhooks) - `/dockerhub`
- [GitLab](https://gitlab.com/help/user/project/integrations/webhooks) - `/gitlab`
- [Heroku](https://devcenter.heroku.com/articles/deploy-hooks#http-post-hook) - `/heroku`
- [Instana](https://www.instana.com/docs/ecosystem/webhook/) - `/instana`
- [Jenkins](https://plugins.jenkins.io/notification) - `/jenkins` (requires the [notification plugin](https://wiki.jenkins.io/display/JENKINS/Notification+Plugin))
- [Jira](https://developer.atlassian.com/server/jira/platform/webhooks/) - `/jira`
- [NewRelic](https://docs.newrelic.com/docs/alerts/new-relic-alerts/managing-notification-channels/customize-your-webhook-payload) - `/newrelic`
- [Patreon](https://www.patreon.com/platform/documentation/webhooks) - `/patreon`
- [Pingdom](https://www.pingdom.com/resources/webhooks) - `/pingdom`
- [Rollbar](https://docs.rollbar.com/docs/webhooks) - `/rollbar`
- [Travis](https://docs.travis-ci.com/user/notifications/#Webhooks-Delivery-Format) - `/travis`
- [Trello](https://developers.trello.com/apis/webhooks) - `/trello`
- [Unity Cloud](https://build-api.cloud.unity3d.com/docs/1.0.0/index.html#operation-webhooks-intro) - `/unity`
- [Uptime Robot](https://blog.uptimerobot.com/web-hook-alert-contacts-new-feature/) - `/uptimerobot`
- [VSTS](https://docs.microsoft.com/en-us/vsts/service-hooks/events#) - `/vsts`
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](https://github.com/Commit451/skyhook/issues).
## Contributing
If you wish to contribute, follow our [contributing guide](CONTRIBUTING.md).
### Creating a Provider
If you want to create a new provider please follow the examples shown at our small [documentation](docs/CreateNewProvider.md).
## 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](https://github.com/Commit451/skyhook-web). This repo/project just includes the backend service.
## Deploying
- [Docker](docs/docker)
- [Google Cloud](docs/gcloud)
## 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!](https://ko-fi.com/jawnnypoo)
## License
skyhook is available under the MIT license. See the LICENSE file for more info.
\ ゜o゜)ノ