https://github.com/khulnasoft/webhooks
https://github.com/khulnasoft/webhooks
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/khulnasoft/webhooks
- Owner: khulnasoft
- License: mit
- Created: 2024-10-23T23:34:24.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-28T22:20:58.000Z (12 months ago)
- Last Synced: 2025-02-01T02:15:58.665Z (8 months ago)
- Language: Go
- Size: 178 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Library webhooks
================
[](https://github.com/khulnasoft/webhooks/actions)
[](https://coveralls.io/github/khulnasoft/webhooks?branch=master)
[](https://goreportcard.com/report/khulnasoft/webhooks)
[](https://godoc.org/github.com/khulnasoft/webhooks)
Library webhooks allows for easy receiving and parsing of GitHub, Bitbucket, GitLab, Docker Hub, Gogs and Azure DevOps Webhook Events
Features:
* Parses the entire payload, not just a few fields.
* Fields + Schema directly lines up with webhook posted json
Notes:
* Currently only accepting json payloads.
Installation
------------
Use go get.
```shell
go get -u github.com/khulnasoft/webhooks
```
Then import the package into your own code.
import "github.com/khulnasoft/webhooks"
Usage and Documentation
------
Please see http://godoc.org/github.com/khulnasoft/webhooks for detailed usage docs.
##### Examples:
```go
package main
import (
"fmt"
"net/http"
"github.com/khulnasoft/webhooks/github"
)
const (
path = "/webhooks"
)
func main() {
hook, _ := github.New(github.Options.Secret("MyGitHubSuperSecretSecret...?"))
http.HandleFunc(path, func(w http.ResponseWriter, r *http.Request) {
payload, err := hook.Parse(r, github.ReleaseEvent, github.PullRequestEvent)
if err != nil {
if err == github.ErrEventNotFound {
// ok event wasn't one of the ones asked to be parsed
}
}
switch payload.(type) {
case github.ReleasePayload:
release := payload.(github.ReleasePayload)
// Do whatever you want from here...
fmt.Printf("%+v", release)
case github.PullRequestPayload:
pullRequest := payload.(github.PullRequestPayload)
// Do whatever you want from here...
fmt.Printf("%+v", pullRequest)
}
})
http.ListenAndServe(":3000", nil)
}
```
Contributing
------
Pull requests for other services are welcome!
If the changes being proposed or requested are breaking changes, please create an issue for discussion.
License
------
Distributed under MIT License, please see license file in code for more details.